ENetrebin (обсуждение | вклад) (Новая страница: «Получает параметры указанного приложения. Запрос создает <code>application/json</code>полезную нагр...») |
Нет описания правки |
||
| (не показаны 4 промежуточные версии 2 участников) | |||
| Строка 1: | Строка 1: | ||
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%95%D0%B4%D0%B8%D0%BD%D1%8B%D0%B9%D0%90%D0%B3%D0%B5%D0%BD%D1%82%20%D0%BD%D0%B0%20%D1%85%D0%BE%D1%81%D1%82%D0%B5-,%D0%A2%D0%BE%D0%BF%D0%BE%D0%BB%D0%BE%D0%B3%D0%B8%D1%8F,-%D0%9F%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F Топология] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A2%D0%BE%D0%BF%D0%BE%D0%BB%D0%BE%D0%B3%D0%B8%D1%8F-,%D0%9F%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F,-GET%20%D0%B2%D1%81%D0%B5%20%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F Приложения] / GET приложения''''' | |||
Получает параметры указанного приложения. | Получает параметры указанного приложения. | ||
| Строка 4: | Строка 6: | ||
{| 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: | Строка 26: | ||
|meIdentifier | |meIdentifier | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима требуемого приложения. | ||
|path | |path | ||
|требуется | |требуется | ||
| Строка 52: | Строка 54: | ||
|entityId | |entityId | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима требуемого объекта. | ||
|- | |- | ||
|displayName | |displayName | ||
|string | |string | ||
|Имя объекта | |Имя объекта АппОптима, отображаемое в пользовательском интерфейсе. | ||
|- | |- | ||
|customizedName | |customizedName | ||
| Строка 127: | Строка 129: | ||
==== Объект <code>TagInfo</code> ==== | ==== Объект <code>TagInfo</code> ==== | ||
Тег сущности | Тег сущности АппОптима. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 164: | Строка 166: | ||
==== Объект <code>EntityShortRepresentation</code> ==== | ==== Объект <code>EntityShortRepresentation</code> ==== | ||
Краткое представление объекта | Краткое представление объекта АппОптима. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 172: | Строка 174: | ||
|id | |id | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима. | ||
|- | |- | ||
|name | |name | ||
|string | |string | ||
|Имя объекта | |Имя объекта АппОптима. | ||
|- | |- | ||
|description | |description | ||
|string | |string | ||
|Краткое описание сущности | |Краткое описание сущности АппОптима. | ||
|} | |} | ||
=== JSON-модель тела ответа === | === JSON-модель тела ответа === | ||
< | <{ | ||
"entityId": "string", | "entityId": "string", | ||
"displayName": "string", | "displayName": "string", | ||
| Строка 212: | Строка 214: | ||
{ | { | ||
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", | "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", | ||
"name": " | "name": "AppOptima entity", | ||
"description": " | "description": "AppOptima entity for the REST API example" | ||
} | } | ||
], | ], | ||
| Строка 219: | Строка 221: | ||
"ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS", | "ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS", | ||
"applicationType": "AGENTLESS_MONITORING" | "applicationType": "AGENTLESS_MONITORING" | ||
} | } | ||
== Пример == | == Пример == | ||
| Строка 227: | Строка 229: | ||
==== 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: | Строка 237: | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
< | <{ | ||
"entityId": "MOBILE_APPLICATION-752C288D59734C79", | "entityId": "MOBILE_APPLICATION-752C288D59734C79", | ||
"displayName": "easyTravel Demo", | "displayName": "easyTravel Demo", | ||
| Строка 277: | Строка 279: | ||
} | } | ||
] | ] | ||
} | } | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
200 | 200 | ||
Текущая версия от 18:19, 2 января 2025
API АппОптима / Эндпойнты среды / Развёртывание / Топология / Приложения / GET приложения
Получает параметры указанного приложения.
Запрос создает 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": "AppOptima entity",
"description": "AppOptima 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