API автоматически определяемых тегов - POST автоматический тег: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Создает новый автоматически применяемый тег. Запрос потребляет и создает <code>application/json</c...») |
ENetrebin (обсуждение | вклад) |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 1: | Строка 1: | ||
Создает новый автоматически применяемый тег. | Создает новый автоматически применяемый тег. | ||
Запрос | Запрос использует и создает в качестве полезной нагрузки <code>application/json</code>формат. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" | | | rowspan="2" |POST | ||
| | |Ключ-АСТРОМ Managed для управления | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags</nowiki></code> | ||
|} | |} | ||
Строка 14: | Строка 14: | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>WriteConfig</code> | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>WriteConfig</code> | ||
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
Строка 22: | Строка 22: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |body | ||
| | |AutoTag | ||
|Тело JSON запроса. Содержит параметры нового автотега. | |Тело JSON запроса. Содержит параметры нового автотега. | ||
| | |body | ||
|необязательный | |необязательный | ||
|} | |} | ||
Строка 34: | Строка 34: | ||
=== Объекты тела запроса === | === Объекты тела запроса === | ||
==== Объект | ==== Объект <code>AutoTag</code> ==== | ||
Конфигурация автотега. Он определяет условия использования тега и значение тега. | Конфигурация автотега. Он определяет условия использования тега и значение тега. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 40: | Строка 40: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |metadata | ||
| | |ConfigurationMetadata | ||
|Метаданные, полезные для отладки | |Метаданные, полезные для отладки | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор автотега. | |Идентификатор автотега. | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Имя автотега, который применяется к | |Имя автотега, который применяется к обьектам. | ||
Кроме того, вы можете указать формат значения в правиле тега. В этом случае тег используется в <code>name:valueFormat</code>формате. | Кроме того, вы можете указать формат значения в правиле тега. В этом случае тег используется в <code>name:valueFormat</code>формате. | ||
Строка 61: | Строка 61: | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |description | ||
| | |string | ||
|Описание автотега. | |Описание автотега. | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |rules | ||
| | |AutoTagRule[] | ||
|Список правил использования тегов. | |Список правил использования тегов. | ||
Строка 74: | Строка 74: | ||
|- | |- | ||
|entitySelectorBasedRules | |entitySelectorBasedRules | ||
| | |EntitySelectorBasedAutoTagRule[] | ||
|Список правил на основе селектора | |Список правил на основе селектора объектов для использования автоматической пометки. | ||
Если указано несколько правил, применяется логика ИЛИ . | Если указано несколько правил, применяется логика ИЛИ . | ||
Строка 81: | Строка 81: | ||
|} | |} | ||
==== Объект | ==== Объект <code>ConfigurationMetadata</code> ==== | ||
Метаданные, полезные для отладки | Метаданные, полезные для отладки | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 87: | Строка 87: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |configurationVersions | ||
| | |integer[] | ||
|Отсортированный список номеров версий конфигурации. | |Отсортированный список номеров версий конфигурации. | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |currentConfigurationVersions | ||
| | |string[] | ||
|Отсортированный список номеров версий конфигурации. | |Отсортированный список номеров версий конфигурации. | ||
|необязательный | |необязательный | ||
|- | |- | ||
|clusterVersion | |clusterVersion | ||
| | |string | ||
|Версия | |Версия Ключ-АСТРОМ. | ||
|необязательный | |необязательный | ||
|} | |} | ||
==== Объект | ==== Объект <code>AutoTagRule</code> ==== | ||
Правило для автоматической пометки. | Правило для автоматической пометки. | ||
Строка 113: | Строка 113: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Тип объектов, к которым применяется правило. | |Тип объектов, к которым применяется правило. | ||
Строка 141: | Строка 141: | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |enabled | ||
| | |boolean | ||
|Правило тегов включено ( <code>true</code>) или отключено ( <code>false</code>). | |Правило тегов включено ( <code>true</code>) или отключено ( <code>false</code>). | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |valueFormat | ||
| | |string | ||
|Значение автотега. Если указано, тег используется в <code>name:valueFormat</code>формате. | |Значение автотега. Если указано, тег используется в <code>name:valueFormat</code>формате. | ||
Строка 347: | Строка 347: | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |normalization | ||
| | |string | ||
|Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | |Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | ||
Строка 358: | Строка 358: | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |propagationTypes | ||
| | |string[] | ||
|Как применить тег к базовым объектам: | |Как применить тег к базовым объектам: | ||
* <code>SERVICE_TO_PROCESS_GROUP_LIKE</code>: применяется к базовым группам процессов соответствующих служб. | * <code>SERVICE_TO_PROCESS_GROUP_LIKE</code>: применяется к базовым группам процессов соответствующих служб. | ||
* <code>SERVICE_TO_HOST_LIKE</code>: | * <code>SERVICE_TO_HOST_LIKE</code>: Применяется к базовым узлам соответствующих служб. | ||
* <code>PROCESS_GROUP_TO_HOST</code>: применяется к базовым хостам соответствующих групп процессов. | * <code>PROCESS_GROUP_TO_HOST</code>: применяется к базовым хостам соответствующих групп процессов. | ||
* <code>PROCESS_GROUP_TO_SERVICE</code>: применяется ко всем службам, предоставляемым группами процессов. | * <code>PROCESS_GROUP_TO_SERVICE</code>: применяется ко всем службам, предоставляемым группами процессов. | ||
Строка 381: | Строка 381: | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |conditions | ||
| | |EntityRuleEngineCondition[] | ||
|Список правил сопоставления для автоматической пометки. | |Список правил сопоставления для автоматической пометки. | ||
Строка 389: | Строка 389: | ||
|} | |} | ||
==== Объект | ==== Объект <code>EntityRuleEngineCondition</code> ==== | ||
Условие определяет, как выполнять логику сопоставления для | Условие определяет, как выполнять логику сопоставления для объекта. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |key | ||
| | |ConditionKey | ||
|Ключ для идентификации данных, которые мы сопоставляем. | |Ключ для идентификации данных, которые мы сопоставляем. | ||
Строка 404: | Строка 404: | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |comparisonInfo | ||
| | |ComparisonBasic | ||
|Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | |Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | ||
Строка 412: | Строка 412: | ||
|} | |} | ||
==== Объект | ==== Объект <code>ConditionKey</code> ==== | ||
Ключ для идентификации данных, которые мы сопоставляем. | Ключ для идентификации данных, которые мы сопоставляем. | ||
Строка 420: | Строка 420: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |attribute | ||
| | |string | ||
|Атрибут, который будет использоваться для сравнения. | |Атрибут, который будет использоваться для сравнения. | ||
Строка 629: | Строка 629: | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | |Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | ||
Строка 636: | Строка 636: | ||
* <code>HOST_CUSTOM_METADATA_KEY</code>-> CustomHostMetadataConditionKey | * <code>HOST_CUSTOM_METADATA_KEY</code>-> CustomHostMetadataConditionKey | ||
* <code>PROCESS_PREDEFINED_METADATA_KEY</code>-> ProcessMetadataConditionKey | * <code>PROCESS_PREDEFINED_METADATA_KEY</code>-> ProcessMetadataConditionKey | ||
* <code>STRING</code>-> | * <code>STRING</code>-> StringConditionKey | ||
* <code>STATIC</code>-> | * <code>STATIC</code>-> StaticConditionKey | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
Строка 649: | Строка 649: | ||
|} | |} | ||
==== Объект | ==== Объект <code>ComparisonBasic</code> ==== | ||
Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | ||
Строка 657: | Строка 657: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |operator | ||
| | |string | ||
|Оператор сравнения. Вы можете изменить его, установив отрицание в <code>true</code>. | |Оператор сравнения. Вы можете изменить его, установив отрицание в <code>true</code>. | ||
Строка 666: | Строка 666: | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |value | ||
| | |object | ||
|Значение для сравнения. | |Значение для сравнения. | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |negate | ||
| | |boolean | ||
|Отменяет оператор сравнения . Например, он превращает начинается с в не начинается с . | |Отменяет оператор сравнения . Например, он превращает начинается с в не начинается с . | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | |Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | ||
* <code>STRING</code>-> | * <code>STRING</code> -> StringComparison | ||
* <code>INDEXED_NAME</code>-> | * <code>INDEXED_NAME</code> -> IndexedNameComparison | ||
* <code>INDEXED_STRING</code>-> | * <code>INDEXED_STRING</code> -> IndexedStringComparison | ||
* <code>INTEGER</code>-> | * <code>INTEGER</code> -> IntegerComparison | ||
* <code>SERVICE_TYPE</code>-> | * <code>SERVICE_TYPE</code> -> ServiceTypeComparison | ||
* <code>PAAS_TYPE</code>-> | * <code>PAAS_TYPE</code> -> PaasTypeComparison | ||
* <code>CLOUD_TYPE</code>-> | * <code>CLOUD_TYPE</code> -> CloudTypeComparison | ||
* <code>AZURE_SKU</code>-> | * <code>AZURE_SKU</code> -> AzureSkuComparision | ||
* <code>AZURE_COMPUTE_MODE</code>-> | * <code>AZURE_COMPUTE_MODE</code> -> AzureComputeModeComparison | ||
* <code>ENTITY_ID</code>-> | * <code>ENTITY_ID</code> -> EntityIdComparison | ||
* <code>SIMPLE_TECH</code>-> | * <code>SIMPLE_TECH</code> -> SimpleTechComparison | ||
* <code>SIMPLE_HOST_TECH</code>-> | * <code>SIMPLE_HOST_TECH</code> -> SimpleHostTechComparison | ||
* <code>SERVICE_TOPOLOGY</code>-> | * <code>SERVICE_TOPOLOGY</code> -> ServiceTopologyComparison | ||
* <code>DATABASE_TOPOLOGY</code>-> | * <code>DATABASE_TOPOLOGY</code> -> DatabaseTopologyComparison | ||
* <code>OS_TYPE</code>-> | * <code>OS_TYPE</code> -> OsTypeComparison | ||
* <code>HYPERVISOR_TYPE</code>-> | * <code>HYPERVISOR_TYPE</code> -> HypervisorTypeComparision | ||
* <code>IP_ADDRESS</code>-> | * <code>IP_ADDRESS</code> -> IpAddressComparison | ||
* <code>OS_ARCHITECTURE</code>-> | * <code>OS_ARCHITECTURE</code> -> OsArchitectureComparison | ||
* <code>BITNESS</code>-> | * <code>BITNESS</code> -> BitnessComparision | ||
* <code>APPLICATION_TYPE</code>-> | * <code>APPLICATION_TYPE</code> -> ApplicationTypeComparison | ||
* <code>MOBILE_PLATFORM</code>-> | * <code>MOBILE_PLATFORM</code> -> MobilePlatformComparison | ||
* <code>CUSTOM_APPLICATION_TYPE</code>-> | * <code>CUSTOM_APPLICATION_TYPE</code> -> CustomApplicationTypeComparison | ||
* <code>DCRUM_DECODER_TYPE</code>-> | * <code>DCRUM_DECODER_TYPE</code> -> DcrumDecoderComparison | ||
* <code>SYNTHETIC_ENGINE_TYPE</code>-> | * <code>SYNTHETIC_ENGINE_TYPE</code> -> SyntheticEngineTypeComparison | ||
* <code>TAG</code>-> | * <code>TAG</code> -> TagComparison | ||
* <code>INDEXED_TAG</code>-> | * <code>INDEXED_TAG</code> -> IndexedTagComparison | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
Строка 738: | Строка 738: | ||
|} | |} | ||
==== Объект | ==== Объект <code>EntitySelectorBasedAutoTagRule</code> ==== | ||
Основанное на селекторе объектов правило для автоматического использования тегов. Он позволяет помечать объекты с помощью селектора объектов. | Основанное на селекторе объектов правило для автоматического использования тегов. Он позволяет помечать объекты с помощью селектора объектов. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 744: | Строка 744: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |enabled | ||
| | |boolean | ||
|Правило включено ( <code>true</code>) или отключено ( <code>false</code>). | |Правило включено ( <code>true</code>) или отключено ( <code>false</code>). | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |entitySelector | ||
| | |string | ||
|Строка селектора объектов, по которой выбираются объекты. | |Строка селектора объектов, по которой выбираются объекты. | ||
|необходимый | |необходимый | ||
|- | |- | ||
| | |valueFormat | ||
| | |string | ||
|Значение автотега на основе селектора объектов. Если указано, тег используется в <code>name:valueFormat</code>формате. | |Значение автотега на основе селектора объектов. Если указано, тег используется в <code>name:valueFormat</code>формате. | ||
Строка 763: | Строка 763: | ||
|необязательный | |необязательный | ||
|- | |- | ||
| | |normalization | ||
| | |string | ||
|Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | |Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | ||
Строка 848: | Строка 848: | ||
|- | |- | ||
|201 | |201 | ||
| | |EntityShortRepresentation | ||
|Успех. Автотег создан. Тело ответа содержит идентификатор нового автотега. | |Успех. Автотег создан. Тело ответа содержит идентификатор нового автотега. | ||
|- | |- | ||
|400 | |400 | ||
|ErrorEnvelope | |ErrorEnvelope | ||
| | |Неуспешно. Ввод недействителен. | ||
|} | |} | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>EntityShortRepresentation</code> ==== | ||
Краткое представление объекта Ключ-АСТРОМ. | Краткое представление объекта Ключ-АСТРОМ. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 865: | Строка 865: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор объекта Ключ-АСТРОМ. | |Идентификатор объекта Ключ-АСТРОМ. | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Имя объекта Ключ-АСТРОМ. | |Имя объекта Ключ-АСТРОМ. | ||
|- | |- | ||
| | |description | ||
| | |string | ||
|Краткое описание | |Краткое описание объекта Ключ-АСТРОМ. | ||
|} | |} | ||
Строка 885: | Строка 885: | ||
}</code> | }</code> | ||
== | == Проверка полезной нагрузки == | ||
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку. | Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку. | ||
Запрос | Запрос использует в качестве полезной нагрузки <code>application/json</code>формат. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" | | | rowspan="2" |POST | ||
| | |Ключ-АСТРОМ Managed для управления | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/validator</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/validator</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/validator</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/validator</nowiki></code> | ||
|} | |} | ||
Строка 901: | Строка 901: | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с <code>WriteConfig</code>областью действия. | Чтобы выполнить этот запрос, вам нужен токен доступа с <code>WriteConfig</code>областью действия. | ||
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
=== Ответ === | === Ответ === | ||
Строка 917: | Строка 917: | ||
|400 | |400 | ||
|ErrorEnvelope | |ErrorEnvelope | ||
| | |Неуспешно. Ввод недействителен. | ||
|} | |} | ||
Строка 927: | Строка 927: | ||
Тело запроса длинное, поэтому оно усекается в разделе Curl . См. тело запроса . Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. | Тело запроса длинное, поэтому оно усекается в разделе Curl . См. тело запроса . Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. | ||
==== | ==== Curl ==== | ||
<code>curl -X POST \ | <code>curl -X POST \ | ||
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags</nowiki> \ | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags</nowiki> \ | ||
Строка 975: | Строка 975: | ||
==== Результат ==== | ==== Результат ==== | ||
Новый автотег выглядит в пользовательском интерфейсе следующим образом: | Новый автотег выглядит в пользовательском интерфейсе следующим образом: | ||
[[Файл:poste.png]] |
Текущая версия на 17:54, 25 апреля 2023
Создает новый автоматически применяемый тег.
Запрос использует и создает в качестве полезной нагрузки application/json
формат.
POST | Ключ-АСТРОМ Managed для управления | https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. WriteConfig
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Обратитесь к моделям JSON , чтобы найти все модели JSON, которые зависят от типа модели.
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
body | AutoTag | Тело JSON запроса. Содержит параметры нового автотега. | body | необязательный |
Объекты тела запроса
Объект 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)"
}
]
}
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
201 | EntityShortRepresentation | Успех. Автотег создан. Тело ответа содержит идентификатор нового автотега. |
400 | ErrorEnvelope | Неуспешно. Ввод недействителен. |
Объекты тела ответа
Объект EntityShortRepresentation
Краткое представление объекта Ключ-АСТРОМ.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор объекта Ключ-АСТРОМ. |
name | string | Имя объекта Ключ-АСТРОМ. |
description | string | Краткое описание объекта Ключ-АСТРОМ. |
JSON-модель тела ответа
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Astromkey entity",
"description": "Astromkey entity for the REST API example"
}
Проверка полезной нагрузки
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос использует в качестве полезной нагрузки application/json
формат.
POST | Ключ-АСТРОМ Managed для управления | https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/validator
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/validator
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с WriteConfig
областью действия.
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
204 | Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела. | |
400 | ErrorEnvelope | Неуспешно. Ввод недействителен. |
Пример
В этом примере запрос создает новый автоматический тег для служб , где имя службы содержит main
. Службам и хостам, на которых они работают, был присвоен тег MainApp .
Токен API передается при авторизации .
Тело запроса длинное, поэтому оно усекается в разделе Curl . См. тело запроса . Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно.
Curl
curl -X POST \
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{ <truncated - see the Request body section > }'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags
Тело запроса
{
"name": "MainApp",
"rules": [
{
"type": "SERVICE",
"enabled": true,
"valueFormat": null,
"propagationTypes": ["SERVICE_TO_HOST_LIKE"],
"conditions": [
{
"key": {
"attribute": "SERVICE_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "CONTAINS",
"value": "main",
"negate": false,
"caseSensitive": false
}
}
]
}
]
}
Тело ответа
{
"id": "e3f5bfc1-ead4-4af8-9372-48beb05e03f9",
"name": "MainApp"
}
Код ответа
201
Результат
Новый автотег выглядит в пользовательском интерфейсе следующим образом: