ENetrebin (обсуждение | вклад) (Новая страница: «Назначает пользовательские теги указанному хосту. Вам нужно только указать значение те...») |
Нет описания правки |
||
| (не показаны 3 промежуточные версии 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=GET%20%D0%B1%D0%B0%D0%B7%D0%BE%D0%B2%D0%BE%D0%B3%D0%BE%20%D1%83%D1%80%D0%BE%D0%B2%D0%BD%D1%8F-,%D0%A5%D0%BE%D1%81%D1%82%D1%8B,-GET%20%D0%B2%D1%81%D0%B5%20%D1%85%D0%BE%D1%81%D1%82%D1%8B Хосты] / GET все приложения''''' | |||
Назначает пользовательские теги указанному хосту. Вам нужно только указать значение тега. Контекст <code>CONTEXTLESS</code>будет назначен автоматически. | Назначает пользовательские теги указанному хосту. Вам нужно только указать значение тега. Контекст <code>CONTEXTLESS</code>будет назначен автоматически. | ||
| Строка 5: | Строка 7: | ||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |POST | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}</nowiki></code> | ||
|- | |- | ||
|Cреда АктивногоШлюза | |Cреда АктивногоШлюза | ||
| Строка 29: | Строка 28: | ||
|meIdentifier | |meIdentifier | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима для хоста, который необходимо обновить. | ||
|path | |path | ||
|требуется | |требуется | ||
| Строка 35: | Строка 34: | ||
|body | |body | ||
|UpdateEntity | |UpdateEntity | ||
|Список тегов, которые должны быть назначены объекту | |Список тегов, которые должны быть назначены объекту АппОптима. | ||
|body | |body | ||
|по желанию | |по желанию | ||
| Строка 43: | Строка 42: | ||
==== Объект <code>UpdateEntity</code> ==== | ==== Объект <code>UpdateEntity</code> ==== | ||
Список тегов, которые должны быть назначены объекту | Список тегов, которые должны быть назначены объекту АппОптима. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 52: | Строка 51: | ||
|tags | |tags | ||
|string [] | |string [] | ||
|Список тегов, которые должны быть назначены объекту | |Список тегов, которые должны быть назначены объекту АппОптима. | ||
|требуется | |требуется | ||
|} | |} | ||
| Строка 58: | Строка 57: | ||
=== JSON-модель тела запроса === | === JSON-модель тела запроса === | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"tags": [ | "tags": [ | ||
"office-linz", | "office-linz", | ||
"office-klagenfurt" | "office-klagenfurt" | ||
] | ] | ||
} | } | ||
== Ответ == | == Ответ == | ||
| Строка 88: | Строка 87: | ||
==== Curl ==== | ==== Curl ==== | ||
< | <curl -X POST \ | ||
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5</nowiki> \ | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | ||
| Строка 97: | Строка 96: | ||
"Rack 123" | "Rack 123" | ||
] | ] | ||
}' | }' | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
| Строка 103: | Строка 102: | ||
==== Тело запроса ==== | ==== Тело запроса ==== | ||
< | <{ | ||
"tags": [ | "tags": [ | ||
"iOS app", | "iOS app", | ||
"Adnroid app" | "Adnroid app" | ||
] | ] | ||
} | } | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
204 | 204 | ||
Текущая версия от 12:38, 29 декабря 2024
API АппОптима / Эндпойнты среды / Развёртывание / Топология / Хосты / GET все приложения
Назначает пользовательские теги указанному хосту. Вам нужно только указать значение тега. Контекст CONTEXTLESSбудет назначен автоматически.
Использование этого API ограничено тегами только со значениями. Чтобы назначить теги ключ:значение, используйте API пользовательских тегов .
Запрос потребляет application/jsonполезную нагрузку.
| POST | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| meIdentifier | string | Идентификатор объекта АппОптима для хоста, который необходимо обновить. | path | требуется |
| body | UpdateEntity | Список тегов, которые должны быть назначены объекту АппОптима. | body | по желанию |
Объекты тела запроса
Объект UpdateEntity
Список тегов, которые должны быть назначены объекту АппОптима.
| Элемент | Тип | Описание | Необходимый |
|---|---|---|---|
| tags | string [] | Список тегов, которые должны быть назначены объекту АппОптима. | требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"tags": [
"office-linz",
"office-klagenfurt"
]
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | Успех. Параметры хоста обновлены. | |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Пример
В этом примере запрос назначает теги Linux и Rack 123 хосту tag009 с идентификатором HOST-B7A6F9EE9F366CB5 .
Маркер API передается в заголовке авторизации .
Curl
<curl -X POST \
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"tags": [
"Linux",
"Rack 123"
]
}'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5
Тело запроса
<{
"tags": [
"iOS app",
"Adnroid app"
]
}
Код ответа
204