API автоматически применяемых тегов - GET все автоматические теги
Материал из Документация Ключ-АСТРОМ
Версия от 18:40, 16 марта 2023; ENetrebin (обсуждение | вклад) (Новая страница: «Список всех автоматически применяемых тегов, определенных в вашей среде Ключ-АСТРОМ. За...»)
Список всех автоматически применяемых тегов, определенных в вашей среде Ключ-АСТРОМ.
Запрос создает в качестве полезной нагрузки application/json
формат.
GET | Ключ-АСТРОМ Managed для управления | https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. ReadConfig
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Запрос не предоставляет никаких настраиваемых параметров.
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | StubList | Успех |
Объекты тела ответа
Объект StubList
Упорядоченный список кратких представлений сущностей Ключ-АСТРОМ.
Элемент | Тип | Описание |
---|---|---|
ценности | EntityShortRepresentation[] | Упорядоченный список кратких представлений сущностей Ключ-АСТРОМ. |
Объект EntityShortRepresentation
Краткое представление объекта Ключ-АСТРОМ.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор объекта Ключ-АСТРОМ. |
name | string | Имя объекта Ключ-АСТРОМ. |
description | string | Краткое описание объекта Ключ-АСТРОМ. |
JSON-модель тела ответа
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Astromkey entity 1",
"description": "Astromkey entity 1 for the REST API example"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Astromkey entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Пример
В этом примере запрос запрашивает список всех автоматических тегов в среде mySampleEnv .
Маркер API передается в заголовке авторизации .
Результат усекается до трех записей.
Curl
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags
Тело ответа
{
"values": [
{
"id": "368a23c5-15fa-4745-9f91-26fbbbd0756c",
"name": "MainApp"
},
{
"id": "b0e81616-01b5-437a-a2ec-7b6cc63a62a3",
"name": "Infrastructure - Windows"
},
{
"id": "7c82c170-b380-4fa7-992a-453f3e73047b",
"name": "Infrastructure - Linux"
}
]
}
Код ответа
200