ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 4: | Строка 4: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |GET | | rowspan="2" |GET | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}</nowiki></code> | ||
|- | |- | ||
Строка 24: | Строка 24: | ||
|meIdentifier | |meIdentifier | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима требуемого приложения. | ||
|path | |path | ||
|требуется | |требуется | ||
Строка 52: | Строка 52: | ||
|entityId | |entityId | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима требуемого объекта. | ||
|- | |- | ||
|displayName | |displayName | ||
|string | |string | ||
|Имя объекта | |Имя объекта АппОптима, отображаемое в пользовательском интерфейсе. | ||
|- | |- | ||
|customizedName | |customizedName | ||
Строка 127: | Строка 127: | ||
==== Объект <code>TagInfo</code> ==== | ==== Объект <code>TagInfo</code> ==== | ||
Тег сущности | Тег сущности АппОптима. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 164: | Строка 164: | ||
==== Объект <code>EntityShortRepresentation</code> ==== | ==== Объект <code>EntityShortRepresentation</code> ==== | ||
Краткое представление объекта | Краткое представление объекта АппОптима. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 172: | Строка 172: | ||
|id | |id | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима. | ||
|- | |- | ||
|name | |name | ||
|string | |string | ||
|Имя объекта | |Имя объекта АппОптима. | ||
|- | |- | ||
|description | |description | ||
|string | |string | ||
|Краткое описание сущности | |Краткое описание сущности АппОптима. | ||
|} | |} | ||
=== JSON-модель тела ответа === | === JSON-модель тела ответа === | ||
< | <{ | ||
"entityId": "string", | "entityId": "string", | ||
"displayName": "string", | "displayName": "string", | ||
Строка 219: | Строка 219: | ||
"ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS", | "ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS", | ||
"applicationType": "AGENTLESS_MONITORING" | "applicationType": "AGENTLESS_MONITORING" | ||
} | } | ||
== Пример == | == Пример == | ||
Строка 227: | Строка 227: | ||
==== Curl ==== | ==== Curl ==== | ||
< | <curl --request GET \ | ||
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79</nowiki> \ | --url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79</nowiki> \ | ||
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' | --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
Строка 235: | Строка 235: | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
< | <{ | ||
"entityId": "MOBILE_APPLICATION-752C288D59734C79", | "entityId": "MOBILE_APPLICATION-752C288D59734C79", | ||
"displayName": "easyTravel Demo", | "displayName": "easyTravel Demo", | ||
Строка 277: | Строка 277: | ||
} | } | ||
] | ] | ||
} | } | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
200 | 200 |
Текущая версия от 14:07, 26 декабря 2024
Получает параметры указанного приложения.
Запрос создает application/json
полезную нагрузку.
GET | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}
|
Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимый |
---|---|---|---|---|
meIdentifier | string | Идентификатор объекта АппОптима требуемого приложения. | path | требуется |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Application | Успех |
Объекты тела ответа
Объект Application
Элемент | Тип | Описание |
---|---|---|
entityId | string | Идентификатор объекта АппОптима требуемого объекта. |
displayName | string | Имя объекта АппОптима, отображаемое в пользовательском интерфейсе. |
customizedName | string | Пользовательское имя объекта |
discoveredName | string | Обнаруженное имя объекта |
firstSeenTimestamp | integer | Отметка времени первого обнаружения объекта в миллисекундах UTC. |
lastSeenTimestamp | integer | Отметка времени последнего обнаружения объекта в миллисекундах UTC. |
tags | TagInfo[] | Список тегов сущностей. |
fromRelationships | object | Список исходящих вызовов из приложения. |
toRelationships | object | Список входящих звонков в приложение. |
applicationMatchTarget | string | -
Элемент может содержать эти значения
|
managementZones | EntityShortRepresentation[] | Зоны управления, частью которых является объект. |
ruleAppliedPattern | string | - |
ruleAppliedMatchType | string | -
Элемент может содержать эти значения
|
applicationType | string | -
Элемент может содержать эти значения
|
Объект TagInfo
Тег сущности АппОптима.
Элемент | Тип | Описание |
---|---|---|
context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
key | string | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
value | string | Значение тега.
Не применимо к пользовательским тегам. |
Объект EntityShortRepresentation
Краткое представление объекта АппОптима.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор объекта АппОптима. |
name | string | Имя объекта АппОптима. |
description | string | Краткое описание сущности АппОптима. |
JSON-модель тела ответа
<{ "entityId": "string", "displayName": "string", "customizedName": "string", "discoveredName": "string", "firstSeenTimestamp": 1, "lastSeenTimestamp": 1, "tags": [ { "context": "AWS", "key": "string", "value": "string" } ], "fromRelationships": { "calls": [ "string" ] }, "toRelationships": { "monitors": [ "string" ] }, "applicationMatchTarget": "DOMAIN", "managementZones": [ { "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Astromkey entity", "description": "Astromkey entity for the REST API example" } ], "ruleAppliedPattern": "string", "ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS", "applicationType": "AGENTLESS_MONITORING" }
Пример
В этом примере запрос запрашивает свойства демо - приложения easyTravel с идентификатором MOBILE_APPLICATION-752C288D59734C79 .
Маркер API передается в заголовке авторизации .
Curl
<curl --request GET \ --url https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79 \ --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79
Тело ответа
<{ "entityId": "MOBILE_APPLICATION-752C288D59734C79", "displayName": "easyTravel Demo", "customizedName": "easyTravel Demo", "discoveredName": "752c288d-5973-4c79-b7d1-3a49d4d42ea0", "firstSeenTimestamp": 1469613941393, "lastSeenTimestamp": 1538656560201, "tags": [ { "context": "CONTEXTLESS", "key": "portal" }, { "context": "CONTEXTLESS", "key": "easyTravel" } ], "fromRelationships": { "calls": [ "SERVICE-ED0B103392AC86BF" ] }, "toRelationships": {}, "mobileOsFamily": [ "ANDROID", "IOS", "WINDOWS" ], "managementZones": [ { "id": "-6239538939987181652", "name": "allTypes" }, { "id": "6518151499932123858", "name": "mobile app name exists" }, { "id": "-4085081632192243904", "name": "easyTravel" } ] }
Код ответа
200