POST тэгов**: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Назначает пользовательские теги указанной службе. Вам нужно указать только значение те...») |
ENetrebin (обсуждение | вклад) |
||
Строка 6: | Строка 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |POST | | rowspan="2" |POST | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}</nowiki></code> | ||
|- | |- |
Текущая версия на 11:42, 13 октября 2022
Назначает пользовательские теги указанной службе. Вам нужно указать только значение тега. Контекст CONTEXTLESS
будет назначен автоматически.
Использование этого API ограничено тегами только со значениями. Чтобы назначить теги ключ:значение, используйте API пользовательских тегов .
Запрос потребляет application/json
полезную нагрузку.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}
|
Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
meIdentifier | string | Идентификатор объекта Ключ-АСТРОМ службы, которую вы запрашиваете. | path | требуется |
body | UpdateEntity | Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ. | body | по желанию |
Объекты тела запроса
Объект UpdateEntity
Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
tags | string [] | Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ. | требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"tags": [
"office-linz",
"office-klagenfurt"
]
}
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
204 | Успех. Параметры сервиса обновлены. | |
400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Пример
В этом примере запрос присваивает PHP - тег PHP-FPM через сервис доменного сокета /run/php7-fpm.sock , который имеет идентификатор SERVICE-72503CBDD2AEF066 .
Маркер API передается в заголовке авторизации .
Curl
curl -X POST \
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"tags": [
"PHP"
]
}'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066
Тело запроса
{
"tags": [
"PHP"
]
}
Код ответа
204