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

Текущая версия от 12:48, 29 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / Топология / Сервисы / POST тэгов**

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

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

Запрос потребляет application/jsonполезную нагрузку.

POST	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}`
POST	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

@@ Строка 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=POST%20%D1%82%D1%8D%D0%B3%D0%BE%D0%B2-,%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B,-GET%20%D0%B2%D1%81%D0%B5%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B Сервисы] / POST тэгов**'''''
 Назначает пользовательские теги указанной службе. Вам нужно указать только значение тега. Контекст <code>CONTEXTLESS</code>будет назначен автоматически.
@@ Строка 6: / Строка 8: @@
 {| class="wikitable"
 | rowspan="2" |POST
-|Удалось
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}</nowiki></code>
 |-
@@ Строка 26: / Строка 28: @@
 |meIdentifier
 |string
-|Идентификатор объекта Ключ-АСТРОМ службы, которую вы запрашиваете.
+|Идентификатор объекта АппОптима службы, которую вы запрашиваете.
 |path
 |требуется
@@ Строка 32: / Строка 34: @@
 |body
 |UpdateEntity
-|Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
+|Список тегов, которые должны быть назначены объекту АппОптима.
 |body
 |по желанию
@@ Строка 40: / Строка 42: @@
 ==== Объект <code>UpdateEntity</code> ====
-Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
+Список тегов, которые должны быть назначены объекту АппОптима.
 {| class="wikitable"
 !Элемент
@@ Строка 49: / Строка 51: @@
 |tags
 |string []
-|Список тегов, которые должны быть назначены объекту Ключ-АСТРОМ.
+|Список тегов, которые должны быть назначены объекту АппОптима.
 |требуется
 |}
@@ Строка 55: / Строка 57: @@
 === JSON-модель тела запроса ===
 Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
-  <code>{
+  <{
     "tags": [
       "office-linz",
       "office-klagenfurt"
     ]
-  }</code>
+  }
 == Ответ ==
@@ Строка 85: / Строка 87: @@
 ==== Curl ====
-  <code>curl -X POST \
+  <curl -X POST \
     <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066</nowiki> \
     -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
@@ Строка 93: / Строка 95: @@
       "PHP"
     ]
-  }'</code>
+  }'
 ==== URL-адрес запроса ====
@@ Строка 99: / Строка 101: @@
 ==== Тело запроса ====
-  <code>{
+  <{
     "tags": [
       "PHP"
     ]
-  }</code>
+  }
 ==== Код ответа ====