API автоматически применяемых тегов - GET автоматический тег: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Получает параметры указанного автоматически применяемого тега. Запрос создает <code>applicat...») |
ENetrebin (обсуждение | вклад) |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 1: | Строка 1: | ||
Получает параметры указанного автоматически применяемого тега. | Получает параметры указанного автоматически применяемого тега. | ||
Запрос создает <code>application/json</code> | Запрос создает в качестве полезной нагрузки <code>application/json</code>формат. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" | | | rowspan="2" |GET | ||
| | |Ключ-АСТРОМ Managed для управления | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}</nowiki></code> | ||
|} | |} | ||
Строка 14: | Строка 14: | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>ReadConfig</code> | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>ReadConfig</code> | ||
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
Строка 21: | Строка 21: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор нужного автотега. | |Идентификатор нужного автотега. | ||
| | |path | ||
|необходимый | |необходимый | ||
|- | |- | ||
|includeProcessGroupReferences | |includeProcessGroupReferences | ||
| | |boolean | ||
|Отметьте, чтобы включить в ответ ссылки на группы процессов. | |Отметьте, чтобы включить в ответ ссылки на группы процессов. | ||
Строка 37: | Строка 37: | ||
Если для этого флага установлено значение <code>false</code>, условия со ссылками на группы процессов удаляются. Если это приводит к тому, что правило не содержит условий, оно удаляется целиком. | Если для этого флага установлено значение <code>false</code>, условия со ссылками на группы процессов удаляются. Если это приводит к тому, что правило не содержит условий, оно удаляется целиком. | ||
| | |query | ||
|необязательный | |необязательный | ||
|} | |} | ||
Строка 51: | Строка 51: | ||
|- | |- | ||
|200 | |200 | ||
| | |AutoTag | ||
|Успех | |Успех | ||
|} | |} | ||
Строка 57: | Строка 57: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>AutoTag</code> ==== | ||
Конфигурация автотега. Он определяет условия использования тега и значение тега. | Конфигурация автотега. Он определяет условия использования тега и значение тега. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 64: | Строка 64: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |metadata | ||
| | |ConfigurationMetadata | ||
|Метаданные, полезные для отладки | |Метаданные, полезные для отладки | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор автотега. | |Идентификатор автотега. | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Имя автотега, который применяется к | |Имя автотега, который применяется к объектам. | ||
Кроме того, вы можете указать формат значения в правиле тега. В этом случае тег используется в <code>name:valueFormat</code>формате. | Кроме того, вы можете указать формат значения в правиле тега. В этом случае тег используется в <code>name:valueFormat</code>формате. | ||
Строка 80: | Строка 80: | ||
Например, вы можете расширить <code>Infrastructure</code>тег до <code>Infrastructure:Windows</code>и <code>Infrastructure:Linux</code>. | Например, вы можете расширить <code>Infrastructure</code>тег до <code>Infrastructure:Windows</code>и <code>Infrastructure:Linux</code>. | ||
|- | |- | ||
| | |description | ||
| | |string | ||
|Описание автотега. | |Описание автотега. | ||
|- | |- | ||
| | |rules | ||
| | |AutoTagRule[] | ||
|Список правил использования тегов. | |Список правил использования тегов. | ||
Строка 91: | Строка 91: | ||
|- | |- | ||
|entitySelectorBasedRules | |entitySelectorBasedRules | ||
| | |EntitySelectorBasedAutoTagRule[] | ||
|Список правил на основе селектора | |Список правил на основе селектора объектов для использования автоматической пометки. | ||
Если указано несколько правил, применяется логика ИЛИ . | Если указано несколько правил, применяется логика ИЛИ . | ||
|} | |} | ||
==== Объект | ==== Объект <code>ConfigurationMetadata</code> ==== | ||
Метаданные, полезные для отладки | Метаданные, полезные для отладки | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 104: | Строка 104: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |configurationVersions | ||
| | |integer[] | ||
|Отсортированный список номеров версий конфигурации. | |Отсортированный список номеров версий конфигурации. | ||
|- | |- | ||
| | |currentConfigurationVersions | ||
| | |string[] | ||
|Отсортированный список номеров версий конфигурации. | |Отсортированный список номеров версий конфигурации. | ||
|- | |- | ||
|clusterVersion | |clusterVersion | ||
| | |string | ||
|Версия | |Версия Ключ-АСТРОМ. | ||
|} | |} | ||
==== Объект | ==== Объект <code>AutoTagRule</code> ==== | ||
Правило для автоматической пометки. | Правило для автоматической пометки. | ||
Строка 126: | Строка 126: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Тип объектов, к которым применяется правило. | |Тип объектов, к которым применяется правило. | ||
Строка 151: | Строка 151: | ||
* <code>SYNTHETIC_TEST</code> | * <code>SYNTHETIC_TEST</code> | ||
|- | |- | ||
| | |enabled | ||
| | |boolean | ||
|Правило тегов включено ( <code>true</code>) или отключено ( <code>false</code>). | |Правило тегов включено ( <code>true</code>) или отключено ( <code>false</code>). | ||
|- | |- | ||
| | |valueFormat | ||
| | |string | ||
|Значение автотега. Если указано, тег используется в <code>name:valueFormat</code>формате. | |Значение автотега. Если указано, тег используется в <code>name:valueFormat</code>формате. | ||
Строка 355: | Строка 355: | ||
* <code>{VmwareVm:Name}</code> | * <code>{VmwareVm:Name}</code> | ||
|- | |- | ||
| | |normalization | ||
| | |string | ||
|Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | |Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения: | ||
* <code>LEAVE_TEXT_AS_IS</code> | |||
* <code>TO_LOWER_CASE</code> | |||
* <code>TO_UPPER_CASE</code> | |||
|- | |- | ||
| | |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>: применяется ко всем службам, предоставляемым группами процессов. | ||
Строка 383: | Строка 387: | ||
* <code>SERVICE_TO_PROCESS_GROUP_LIKE</code> | * <code>SERVICE_TO_PROCESS_GROUP_LIKE</code> | ||
|- | |- | ||
| | |conditions | ||
| | |EntityRuleEngineCondition[] | ||
|Список правил сопоставления для автоматической пометки. | |Список правил сопоставления для автоматической пометки. | ||
Строка 390: | Строка 394: | ||
|} | |} | ||
==== Объект | ==== Объект <code>EntityRuleEngineCondition</code> ==== | ||
Условие определяет, как выполнять логику сопоставления для сущности. | Условие определяет, как выполнять логику сопоставления для сущности. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 397: | Строка 401: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |key | ||
| | |ConditionKey | ||
|Ключ для идентификации данных, которые мы сопоставляем. | |Ключ для идентификации данных, которые мы сопоставляем. | ||
Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . | Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . | ||
|- | |- | ||
| | |comparisonInfo | ||
| | |ComparisonBasic | ||
|Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | |Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | ||
Строка 410: | Строка 414: | ||
|} | |} | ||
==== Объект | ==== Объект <code>ConditionKey</code> ==== | ||
Ключ для идентификации данных, которые мы сопоставляем. | Ключ для идентификации данных, которые мы сопоставляем. | ||
Строка 419: | Строка 423: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |attribute | ||
| | |string | ||
|Атрибут, который будет использоваться для сравнения. | |Атрибут, который будет использоваться для сравнения. | ||
Строка 625: | Строка 629: | ||
* <code>WEB_APPLICATION_TYPE</code> | * <code>WEB_APPLICATION_TYPE</code> | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | |Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | ||
Строка 632: | Строка 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 | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
Строка 644: | Строка 648: | ||
|} | |} | ||
==== Объект | ==== Объект <code>ComparisonBasic</code> ==== | ||
Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем. | ||
Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . | Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON . | ||
Строка 653: | Строка 657: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |operator | ||
| | |string | ||
|Оператор сравнения. Вы можете изменить его, установив отрицание в <code>true</code>. | |Оператор сравнения. Вы можете изменить его, установив отрицание в <code>true</code>. | ||
Возможные значения зависят от типа сравнения. Найдите список актуальных моделей в описании поля типа и проверьте описание нужной вам модели. | Возможные значения зависят от типа сравнения. Найдите список актуальных моделей в описании поля типа и проверьте описание нужной вам модели. | ||
|- | |- | ||
| | |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 | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
Строка 728: | Строка 732: | ||
|} | |} | ||
==== Объект | ==== Объект <code>EntitySelectorBasedAutoTagRule</code> ==== | ||
Основанное на селекторе объектов правило для автоматического использования тегов. Он позволяет помечать объекты с помощью селектора объектов. | Основанное на селекторе объектов правило для автоматического использования тегов. Он позволяет помечать объекты с помощью селектора объектов. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 735: | Строка 739: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |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>формате. | ||
Например, вы можете расширить <code>Infrastructure</code>тег до <code>Infrastructure:Windows</code>и <code>Infrastructure:Linux</code>. | Например, вы можете расширить <code>Infrastructure</code>тег до <code>Infrastructure:Windows</code>и <code>Infrastructure:Linux</code>. | ||
|- | |- | ||
| | |normalization | ||
| | |string | ||
|Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | |Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS. | ||
Строка 830: | Строка 834: | ||
Маркер API передается в заголовке авторизации . | Маркер API передается в заголовке авторизации . | ||
==== | ==== Curl ==== | ||
<code>curl -X GET \ | <code>curl -X GET \ | ||
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags/7c82c170-b380-4fa7-992a-453f3e73047b</nowiki> \ | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags/7c82c170-b380-4fa7-992a-453f3e73047b</nowiki> \ |
Текущая версия на 18:15, 2 мая 2023
Получает параметры указанного автоматически применяемого тега.
Запрос создает в качестве полезной нагрузки 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