Получение тегов
Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаемым объектам. Автоматически применяемые теги и импортированные теги не включаются.
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/tags
|
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/tags
| |
Environment Активный Шлюз | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tags
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение сущностей ( entities.read
) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
entitySelector | string | Указывает объекты, в которых вы хотите прочитать теги.
Вы должны установить один из этих критериев:
Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и
Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-АСТРОМ. Чтобы задать несколько критериев, разделите их запятой ( Длина строки ограничена 10 000 символов. |
запрос | требуется |
from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не установлено, используется относительный временной интервал 24 часа ( |
запрос | необязательный |
to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
запрос | необязательный |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | CustomEntityTags | Успех |
Объекты тела ответа
Объект _ CustomEntityTags
Список пользовательских тегов.
Элемент | Тип | Описание |
---|---|---|
totalCount | integer | Общее количество тегов в ответе.
Может быть |
tags | METag[] | Список пользовательских тегов. |
Объект _ METag
Тег отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
stringRepresentation | string | Строковое представление тега.
Может быть |
value | string | Значение тега.
Может быть |
key | string | Ключ тега.
Может быть |
context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Может быть |
JSON-модель тела ответа
{
"totalCount": 2,
"tags": [
{
"context": "CONTEXTLESS",
"key": "mainApp",
"stringRepresentation": "mainApp"
},
{
"context": "CONTEXTLESS",
"key": "bookings",
"stringRepresentation": "bookings"
}
]
}
Пример
В этом примере в запросе перечислены настраиваемые теги, которые применяются к службам, принадлежащим зонам управления с идентификатором 229130632296508575249 . Для этого параметру запроса entitySelector присваиваетсяtype("SERVICE"),mzId("9130632296508575249")
значение .
Маркер API передается в заголовке авторизации .
Поскольку полный результат довольно длинный, он усечен до трех записей.
Curl
curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)
Тело ответа
{
"totalCount": 31,
"tags": [
{
"context": "CONTEXTLESS",
"key": "Billing",
"stringRepresentation": "Billing"
},
{
"context": "CONTEXTLESS",
"key": "Booking",
"stringRepresentation": "Booking"
},
{
"context": "CONTEXTLESS",
"key": "easytravel",
"value": "backend",
"stringRepresentation": "easytravel:backend"
}
]
}
Код ответа
200