POST-теги
API Ключ-АСТРОМ / Эндпойнты среды / Пользовательские теги / POST-теги
Данная функция позволяет добавить настраиваемые теги к указанным отслеживаемым объектам.
Запрос потребляет и создает application/json
полезную нагрузку.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/tags
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tags
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на запись объектов ( entities.write
) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
entitySelector | string | Указывает объекты, теги которых вы хотите обновить.
Вы должны установить один из этих критериев:
Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и
Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-АСТРОМ. Чтобы задать несколько критериев, разделите их запятой ( Длина строки ограничена 10 000 символов. |
запрос | требуется |
from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не установлено, используется относительный временной интервал 24 часа ( |
запрос | необязательный |
to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
запрос | необязательный |
body | Добавить теги сущностей | Тело JSON запроса. Содержит теги, которые необходимо добавить к соответствующим объектам. | body | необязательный |
Объекты тела запроса
Объект AddEntityTags
Список тегов, которые будут добавлены к отслеживаемым объектам.
Элемент | Тип | Описание |
---|---|---|
tags | AddEntityTag[] | Список тегов, которые будут добавлены к отслеживаемым объектам. |
Объект AddEntityTag
Пользовательский тег, добавляемый к отслеживаемым объектам.
Элемент | Тип | Описание |
---|---|---|
value | string | Значение пользовательского тега, добавляемого к отслеживаемым объектам. Может быть нулевым
Может быть |
key | string | Ключ пользовательского тега, который будет добавлен к отслеживаемым объектам. |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"tags": [
{
"key": "mainApp"
},
{
"key": "bookings",
"value": "42"
}
]
}
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | AddedEntityTags | Успех |
Объекты тела ответа
Объект AddedEntityTags
Список настраиваемых тегов, добавленных к отслеживаемым объектам.
Элемент | Тип | Описание |
---|---|---|
matchedEntitiesCount | integer | Количество отслеживаемых объектов, в которые были добавлены теги.
Может быть |
appliedTags | METag[] | Список добавленных пользовательских тегов.
Может быть |
Объект METag
Тег отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
stringRepresentation | string | Строковое представление тега.
Может быть |
value | string | Значение тега.
Может быть |
key | string | Ключ тега.
Может быть |
context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Может быть |
JSON-модель тела ответа
{
"appliedTags": [
{
"context": "CONTEXTLESS",
"key": "mainApp",
"stringRepresentation": "mainApp"
},
{
"context": "CONTEXTLESS",
"key": "booking",
"stringRepresentation": "booking"
}
],
"matchedEntitiesCount": 2
}
Пример
В этом примере запрос добавляет пользовательские теги REST-test и RESTexample к хостам, которые уже имеют тег easyTravel . Для этого параметру запроса entitySelector присваиваетсяtype("HOST"),tag("easyTravel")
значение .
Маркер API передается в заголовке авторизации .
Curl
curl -L -X POST 'https://mySampleEnv.live.astromkey.com/api/v2/tags?entitySelector=type(%22HOST%22),tag(%22easyTravel%22)' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"tags": [
{
"key": "REST-test"
},
{
"key": "RESTexample"
}
]
}'
URL-адрес запроса
https://mySampleEnv.live.astromkey.com/api/v2/tags?entitySelector=type(%22HOST%22),tag(%22easyTravel%22)
Тело запроса
{
"tags": [
{
"key": "REST-test"
},
{
"key": "RESTexample"
}
]
}
Тело ответа
{
"matchedEntitiesCount": 3,
"appliedTags": [
{
"context": "CONTEXTLESS",
"key": "REST-test",
"stringRepresentation": "REST-test"
},
{
"context": "CONTEXTLESS",
"key": "RESTexample",
"stringRepresentation": "RESTexample"
}
]
}
Код ответа
200