POST тэгов*: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Назначает пользовательские теги указанной группе процессов . Вам нужно только указать з...»)
 
 
Строка 21: Строка 21:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|meIdentifier
|meIdentifier
|string
|string
|Идентификатор объекта Ключ-АСТРОМ для группы процессов, которую необходимо обновить.
|Идентификатор объекта Ключ-АСТРОМ для группы процессов, которую необходимо обновить.
|дорожка
|path
|требуется
|требуется
|-
|-
|тело
|body
|Обновить сущность
|UpdateEntity
|Тело JSON запроса. Содержит теги, которые необходимо добавить в группу процессов.
|Тело JSON запроса. Содержит теги, которые необходимо добавить в группу процессов.
|тело
|body
|по желанию
|по желанию
|}
|}
Строка 39: Строка 39:
=== Объекты тела запроса ===
=== Объекты тела запроса ===


==== Объект _ <code>UpdateEntity</code> ====
==== Объект <code>UpdateEntity</code> ====
Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
{| class="wikitable"
{| class="wikitable"
Строка 45: Строка 45:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|теги
|tags
|строка []
|string []
|Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
|Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
|требуется
|требуется

Текущая версия на 09:58, 13 октября 2022

Назначает пользовательские теги указанной группе процессов . Вам нужно только указать значение тега. Контекст CONTEXTLESSбудет назначен автоматически.

Использование этого API ограничено тегами только со значениями. Чтобы назначить теги ключ:значение, используйте API пользовательских тегов .

Запрос производитapplication/json

POST Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}
Cреда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
meIdentifier string Идентификатор объекта Ключ-АСТРОМ для группы процессов, которую необходимо обновить. path требуется
body UpdateEntity Тело JSON запроса. Содержит теги, которые необходимо добавить в группу процессов. body по желанию

Объекты тела запроса

Объект UpdateEntity

Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.

Элемент Тип Описание Необходимость
tags string [] Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ. требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "tags": [
    "office-linz",
    "office-klagenfurt"
  ]
}

Ответ

Коды ответов

Код Тип Описание
204 Успех. Параметры группы процессов обновлены.
400 ErrorEnvelope Не удалось. Ввод недействителен.

Пример

В этом примере запрос назначает тег PHP группе процессов PHP-FPM с идентификатором PROCESS_GROUP-E5C3CC7EC1F80B5B .

Маркер API передается в заголовке авторизации .

Завиток

curl -X POST \
  https://mySampleEnv.live.ruscomtech.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "tags": [
    "PHP"
  ]
}'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B

Тело запроса

{
  "tags": [
    "PHP"
  ]
}

Код ответа

204