ENetrebin (обсуждение | вклад) (Новая страница: «Назначает пользовательские теги указанному хосту. Вам нужно только указать значение те...») |
ENetrebin (обсуждение | вклад) Нет описания правки |
||
| Строка 5: | Строка 5: | ||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |POST | ||
|Managed | |Managed | ||
|<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реда АктивногоШлюза | ||
Версия от 17:12, 12 октября 2022
Назначает пользовательские теги указанному хосту. Вам нужно только указать значение тега. Контекст CONTEXTLESSбудет назначен автоматически.
Использование этого API ограничено тегами только со значениями. Чтобы назначить теги ключ:значение, используйте API пользовательских тегов .
Запрос потребляет application/jsonполезную нагрузку.
| POST | Managed | 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