API автоматически применяемых тегов - GET автоматический тег
Получает параметры указанного автоматически применяемого тега.
Запрос создает application/json
полезную нагрузку.
ПОЛУЧАТЬ | УдалосьКлюч-АСТРОМ для правительства | https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}
|
Окружающая среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. ReadConfig
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | В | Необходимый |
---|---|---|---|---|
идентификатор | нить | Идентификатор нужного автотега. | путь | необходимый |
includeProcessGroupReferences | логический | Отметьте, чтобы включить в ответ ссылки на группы процессов.
Ссылки на группы процессов несовместимы в разных средах. Если для этого флага установлено значение |
запрос | необязательный |
Ответ
Обратитесь к моделям JSON , чтобы найти все модели JSON, которые зависят от типа модели.
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Автоматическая метка | Успех |
Объекты тела ответа
Объект _ AutoTag
Конфигурация автотега. Он определяет условия использования тега и значение тега.
Элемент | Тип | Описание |
---|---|---|
метаданные | Метаданные конфигурации | Метаданные, полезные для отладки |
идентификатор | нить | Идентификатор автотега. |
имя | нить | Имя автотега, который применяется к сущностям.
Кроме того, вы можете указать формат значения в правиле тега. В этом случае тег используется в Например, вы можете расширить |
описание | нить | Описание автотега. |
правила | Правило автоматической маркировки [] | Список правил использования тегов.
При наличии нескольких правил применяется логика ИЛИ. |
entitySelectorBasedRules | Правило автотегов на основе селектора сущностей [] | Список правил на основе селектора сущностей для использования автоматической пометки.
Если указано несколько правил, применяется логика ИЛИ . |
Объект _ ConfigurationMetadata
Метаданные, полезные для отладки
Элемент | Тип | Описание |
---|---|---|
конфигурацияВерсии | целое [] | Отсортированный список номеров версий конфигурации. |
текущие версии конфигурации | строка [] | Отсортированный список номеров версий конфигурации. |
clusterVersion | нить | Версия Дайнатрейс. |
Объект _ AutoTagRule
Правило для автоматической пометки.
Определяет условия использования тега.
Элемент | Тип | Описание |
---|---|---|
тип | нить | Тип объектов, к которым применяется правило.
Элемент может содержать эти значения
|
включено | логический | Правило тегов включено ( true ) или отключено ( false ).
|
формат значения | нить | Значение автотега. Если указано, тег используется в name:valueFormat формате.
Например, вы можете расширить Здесь вы можете использовать следующие заполнители:
|
нормализация | нить | Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS.
Элемент может содержать эти значения |
Типы распространения | строка [] | Как применить тег к базовым объектам:
Элемент может содержать эти значения
|
условия | Состояние ядра правила сущности [] | Список правил сопоставления для автоматической пометки.
Тег применяется только при выполнении всех условий. |
Объект _ EntityRuleEngineCondition
Условие определяет, как выполнять логику сопоставления для сущности.
Элемент | Тип | Описание |
---|---|---|
ключ | Ключ условия | Ключ для идентификации данных, которые мы сопоставляем.
Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . |
сравнениеИнформация | Основное сравнение | Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем.
Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . |
Объект _ ConditionKey
Ключ для идентификации данных, которые мы сопоставляем.
Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .
Элемент | Тип | Описание |
---|---|---|
атрибут | нить | Атрибут, который будет использоваться для сравнения.
Элемент может содержать эти значения
|
тип | нить | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
Объект _ ComparisonBasic
Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем.
Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .
Элемент | Тип | Описание |
---|---|---|
оператор | нить | Оператор сравнения. Вы можете изменить его, установив отрицание в true .
Возможные значения зависят от типа сравнения. Найдите список актуальных моделей в описании поля типа и проверьте описание нужной вам модели. |
ценить | объект | Значение для сравнения. |
отрицать | логический | Отменяет оператор сравнения . Например, он превращает начинается с в не начинается с . |
тип | нить | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
Объект _ EntitySelectorBasedAutoTagRule
Основанное на селекторе объектов правило для автоматического использования тегов. Он позволяет помечать объекты с помощью селектора объектов.
Элемент | Тип | Описание |
---|---|---|
включено | логический | Правило включено ( true ) или отключено ( false ).
|
селектор объектов | нить | Строка селектора объектов, по которой выбираются объекты. |
формат значения | нить | Значение автотега на основе селектора объектов. Если указано, тег используется в name:valueFormat формате.
Например, вы можете расширить |
нормализация | нить | Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS.
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"name": "sampleAutoTag",
"description": "sampleDescription",
"rules": [
{
"type": "SERVICE",
"enabled": true,
"valueFormat": "myTagValue {Service:DetectedName}",
"propagationTypes": [
"SERVICE_TO_HOST_LIKE"
],
"conditions": [
{
"key": {
"attribute": "SERVICE_DATABASE_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "BEGINS_WITH",
"value": "sample",
"negate": false,
"caseSensitive": false
}
},
{
"key": {
"attribute": "SERVICE_WEB_SERVER_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "EXISTS",
"negate": false
}
},
{
"key": {
"attribute": "PROCESS_GROUP_CUSTOM_METADATA",
"type": "PROCESS_CUSTOM_METADATA_KEY",
"dynamicKey": {
"source": "KUBERNETES",
"key": "kubernetes.io/limit-ranger"
}
},
"comparisonInfo": {
"type": "STRING",
"operator": "BEGINS_WITH",
"value": "sample",
"negate": false,
"caseSensitive": false
}
}
]
}
],
"entitySelectorBasedRules": [
{
"enabled": true,
"entitySelector": "type(HOST) AND cpuCores(4)"
}
]
}
Пример
В этом примере запрос запрашивает свойства автотега Infrastructure — Linux с идентификатором 7c82c170-b380-4fa7-992a-453f3e73047b .
Конфигурация имеет следующие настройки:
Маркер API передается в заголовке авторизации .
Завиток
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags/7c82c170-b380-4fa7-992a-453f3e73047b \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags/7c82c170-b380-4fa7-992a-453f3e73047b
Тело ответа
{
"metadata": {
"configurationVersions": [
7
],
"clusterVersion": "1.176.0.20190808-181828"
},
"id": "7c82c170-b380-4fa7-992a-453f3e73047b",
"name": "Infrastructure - Linux",
"rules": [
{
"type": "HOST",
"enabled": true,
"valueFormat": "prodLinux",
"propagationTypes": [],
"conditions": [
{
"key": {
"attribute": "HOST_OS_TYPE"
},
"comparisonInfo": {
"type": "OS_TYPE",
"operator": "EQUALS",
"value": "LINUX",
"negate": false
}
},
{
"key": {
"attribute": "HOST_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "BEGINS_WITH",
"value": "PreProd",
"negate": true,
"caseSensitive": true
}
}
]
}
]
}
Код ответа
200