API автоматически применяемых тегов - GET автоматический тег
Получает параметры указанного автоматически применяемого тега.
Запрос создает в качестве полезной нагрузки application/json
формат.
GET | Ключ-АСТРОМ Managed для управления | https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. ReadConfig
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
id | string | Идентификатор нужного автотега. | path | необходимый |
includeProcessGroupReferences | boolean | Отметьте, чтобы включить в ответ ссылки на группы процессов.
Ссылки на группы процессов несовместимы в разных средах. Если для этого флага установлено значение |
query | необязательный |
Ответ
Обратитесь к моделям JSON , чтобы найти все модели JSON, которые зависят от типа модели.
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | AutoTag | Успех |
Объекты тела ответа
Объект AutoTag
Конфигурация автотега. Он определяет условия использования тега и значение тега.
Элемент | Тип | Описание |
---|---|---|
metadata | ConfigurationMetadata | Метаданные, полезные для отладки |
id | string | Идентификатор автотега. |
name | string | Имя автотега, который применяется к объектам.
Кроме того, вы можете указать формат значения в правиле тега. В этом случае тег используется в Например, вы можете расширить |
description | string | Описание автотега. |
rules | AutoTagRule[] | Список правил использования тегов.
При наличии нескольких правил применяется логика ИЛИ. |
entitySelectorBasedRules | EntitySelectorBasedAutoTagRule[] | Список правил на основе селектора объектов для использования автоматической пометки.
Если указано несколько правил, применяется логика ИЛИ . |
Объект ConfigurationMetadata
Метаданные, полезные для отладки
Элемент | Тип | Описание |
---|---|---|
configurationVersions | integer[] | Отсортированный список номеров версий конфигурации. |
currentConfigurationVersions | string[] | Отсортированный список номеров версий конфигурации. |
clusterVersion | string | Версия Ключ-АСТРОМ. |
Объект AutoTagRule
Правило для автоматической пометки.
Определяет условия использования тега.
Элемент | Тип | Описание |
---|---|---|
type | string | Тип объектов, к которым применяется правило.
Элемент может содержать эти значения
|
enabled | boolean | Правило тегов включено ( true ) или отключено ( false ).
|
valueFormat | string | Значение автотега. Если указано, тег используется в name:valueFormat формате.
Например, вы можете расширить Здесь вы можете использовать следующие заполнители:
|
normalization | string | Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS.
Элемент может содержать эти значения:
|
propagationTypes | string[] | Как применить тег к базовым объектам:
Элемент может содержать эти значения
|
conditions | EntityRuleEngineCondition[] | Список правил сопоставления для автоматической пометки.
Тег применяется только при выполнении всех условий. |
Объект EntityRuleEngineCondition
Условие определяет, как выполнять логику сопоставления для сущности.
Элемент | Тип | Описание |
---|---|---|
key | ConditionKey | Ключ для идентификации данных, которые мы сопоставляем.
Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . |
comparisonInfo | ComparisonBasic | Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем.
Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . |
Объект ConditionKey
Ключ для идентификации данных, которые мы сопоставляем.
Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .
Элемент | Тип | Описание |
---|---|---|
attribute | string | Атрибут, который будет использоваться для сравнения.
Элемент может содержать эти значения
|
type | string | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
Объект ComparisonBasic
Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем.
Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .
Элемент | Тип | Описание |
---|---|---|
operator | string | Оператор сравнения. Вы можете изменить его, установив отрицание в true .
Возможные значения зависят от типа сравнения. Найдите список актуальных моделей в описании поля типа и проверьте описание нужной вам модели. |
value | object | Значение для сравнения. |
negate | boolean | Отменяет оператор сравнения . Например, он превращает начинается с в не начинается с . |
type | string | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
Объект EntitySelectorBasedAutoTagRule
Основанное на селекторе объектов правило для автоматического использования тегов. Он позволяет помечать объекты с помощью селектора объектов.
Элемент | Тип | Описание |
---|---|---|
enabled | boolean | Правило включено ( true ) или отключено ( false ).
|
entitySelector | string | Строка селектора объектов, по которой выбираются объекты. |
valueFormat | string | Значение автотега на основе селектора объектов. Если указано, тег используется в name:valueFormat формате.
Например, вы можете расширить |
normalization | string | Изменения, примененные к значению после применения формата значения. По умолчанию 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
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