API автоматически применяемых тегов - PUT автоматический тег

Материал из Документация Ключ-АСТРОМ

Обновляет указанный автоматически применяемый тег.

Запрос потребляет и создает application/jsonполезную нагрузку.

PUT Ключ-АСТРОМ Mansged для управления 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}

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. WriteConfig

Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Обратитесь к моделям JSON , чтобы найти все модели JSON, которые зависят от типа модели.

Параметр Тип Описание В Необходимый
идентификатор нить Идентификатор автотега, который необходимо обновить.

Если вы также устанавливаете идентификатор в теле сообщения, он должен совпадать с этим идентификатором.

путь необходимый
тело Автоматическая метка Тело JSON запроса. Содержит обновленные параметры автотега. тело необязательный

Объекты тела запроса

Объект _ AutoTag

Конфигурация автотега. Он определяет условия использования тега и значение тега.

Элемент Тип Описание Необходимый
метаданные Метаданные конфигурации Метаданные, полезные для отладки необязательный
идентификатор нить Идентификатор автотега. необязательный
имя нить Имя автотега, который применяется к сущностям.

Кроме того, вы можете указать формат значения в правиле тега. В этом случае тег используется в name:valueFormatформате.

Например, вы можете расширить Infrastructureтег до Infrastructure:Windowsи Infrastructure:Linux.

необходимый
описание нить Описание автотега. необязательный
правила Правило автоматической маркировки [] Список правил использования тегов.

При наличии нескольких правил применяется логика ИЛИ.

необязательный
entitySelectorBasedRules Правило автотегов на основе селектора сущностей [] Список правил на основе селектора сущностей для использования автоматической пометки.

Если указано несколько правил, применяется логика ИЛИ .

необязательный

Объект _ ConfigurationMetadata

Метаданные, полезные для отладки

Элемент Тип Описание Необходимый
конфигурацияВерсии целое [] Отсортированный список номеров версий конфигурации. необязательный
текущие версии конфигурации строка [] Отсортированный список номеров версий конфигурации. необязательный
clusterVersion нить Версия Дайнатрейс. необязательный

Объект _ AutoTagRule

Правило для автоматической пометки.

Определяет условия использования тега.

Элемент Тип Описание Необходимый
тип нить Тип объектов, к которым применяется правило.

Элемент может содержать эти значения

  • APPLICATION
  • AWS_APPLICATION_LOAD_BALANCER
  • AWS_CLASSIC_LOAD_BALANCER
  • AWS_NETWORK_LOAD_BALANCER
  • AWS_RELATIONAL_DATABASE_SERVICE
  • AZURE
  • CUSTOM_APPLICATION
  • CUSTOM_DEVICE
  • DCRUM_APPLICATION
  • ESXI_HOST
  • EXTERNAL_SYNTHETIC_TEST
  • HOST
  • HTTP_CHECK
  • MOBILE_APPLICATION
  • MULTIPROTOCOL_MONITOR
  • PROCESS_GROUP
  • SERVICE
  • SYNTHETIC_TEST
необходимый
включено логический Правило тегов включено ( true) или отключено ( false). необходимый
формат значения нить Значение автотега. Если указано, тег используется в name:valueFormatформате.

Например, вы можете расширить Infrastructureтег до Infrastructure:Windowsи Infrastructure:Linux.

Здесь вы можете использовать следующие заполнители:

  • {AwsAutoScalingGroup:Name}
  • {AwsAvailabilityZone:Name}
  • {AwsElasticLoadBalancer:Name}
  • {AwsRelationalDatabaseService:DBName}
  • {AwsRelationalDatabaseService:Endpoint}
  • {AwsRelationalDatabaseService:Engine}
  • {AwsRelationalDatabaseService:InstanceClass}
  • {AwsRelationalDatabaseService:Name}
  • {AwsRelationalDatabaseService:Port}
  • {AzureRegion:Name}
  • {AzureScaleSet:Name}
  • {AzureVm:Name}
  • {CloudFoundryOrganization:Name}
  • {CustomDevice:DetectedName}
  • {CustomDevice:DnsName}
  • {CustomDevice:IpAddress}
  • {CustomDevice:Port}
  • {DockerContainerGroupInstance:ContainerName}
  • {DockerContainerGroupInstance:FullImageName}
  • {DockerContainerGroupInstance:ImageVersion}
  • {DockerContainerGroupInstance:StrippedImageName}
  • {ESXIHost:HardwareModel}
  • {ESXIHost:HardwareVendor}
  • {ESXIHost:Name}
  • {ESXIHost:ProductName}
  • {ESXIHost:ProductVersion}
  • {Ec2Instance:AmiId}
  • {Ec2Instance:BeanstalkEnvironmentName}
  • {Ec2Instance:InstanceId}
  • {Ec2Instance:InstanceType}
  • {Ec2Instance:LocalHostName}
  • {Ec2Instance:Name}
  • {Ec2Instance:PublicHostName}
  • {Ec2Instance:SecurityGroup}
  • {GoogleComputeInstance:Id}
  • {GoogleComputeInstance:IpAddresses}
  • {GoogleComputeInstance:MachineType}
  • {GoogleComputeInstance:Name}
  • {GoogleComputeInstance:ProjectId}
  • {GoogleComputeInstance:Project}
  • {Host:AWSNameTag}
  • {Host:AixLogicalCpuCount}
  • {Host:AzureHostName}
  • {Host:AzureSiteName}
  • {Host:BoshDeploymentId}
  • {Host:BoshInstanceId}
  • {Host:BoshInstanceName}
  • {Host:BoshName}
  • {Host:BoshStemcellVersion}
  • {Host:CpuCores}
  • {Host:DetectedName}
  • {Host:Environment:AppName}
  • {Host:Environment:BoshReleaseVersion}
  • {Host:Environment:Environment}
  • {Host:Environment:Link}
  • {Host:Environment:Organization}
  • {Host:Environment:Owner}
  • {Host:Environment:Support}
  • {Host:IpAddress}
  • {Host:LogicalCpuCores}
  • {Host:OneAgentCustomHostName}
  • {Host:OperatingSystemVersion}
  • {Host:PaasMemoryLimit}
  • {HostGroup:Name}
  • {KubernetesCluster:Name}
  • {KubernetesNode:DetectedName}
  • {OpenstackAvailabilityZone:Name}
  • {OpenstackZone:Name}
  • {OpenstackComputeNode:Name}
  • {OpenstackProject:Name}
  • {OpenstackVm:UnstanceType}
  • {OpenstackVm:Name}
  • {OpenstackVm:SecurityGroup}
  • {ProcessGroup:AmazonECRImageAccountId}
  • {ProcessGroup:AmazonECRImageRegion}
  • {ProcessGroup:AmazonECSCluster}
  • {ProcessGroup:AmazonECSContainerName}
  • {ProcessGroup:AmazonECSFamily}
  • {ProcessGroup:AmazonECSRevision}
  • {ProcessGroup:AmazonLambdaFunctionName}
  • {ProcessGroup:AmazonRegion}
  • {ProcessGroup:ApacheConfigPath}
  • {ProcessGroup:ApacheSparkMasterIpAddress}
  • {ProcessGroup:AspDotNetCoreApplicationPath}
  • {ProcessGroup:AspDotNetCoreApplicationPath}
  • {ProcessGroup:AzureHostName}
  • {ProcessGroup:AzureSiteName}
  • {ProcessGroup:CassandraClusterName}
  • {ProcessGroup:CatalinaBase}
  • {ProcessGroup:CatalinaHome}
  • {ProcessGroup:CloudFoundryAppId}
  • {ProcessGroup:CloudFoundryAppName}
  • {ProcessGroup:CloudFoundryInstanceIndex}
  • {ProcessGroup:CloudFoundrySpaceId}
  • {ProcessGroup:CloudFoundrySpaceName}
  • {ProcessGroup:ColdFusionJvmConfigFile}
  • {ProcessGroup:ColdFusionServiceName}
  • {ProcessGroup:CommandLineArgs}
  • {ProcessGroup:DetectedName}
  • {ProcessGroup:DotNetCommandPath}
  • {ProcessGroup:DotNetCommand}
  • {ProcessGroup:DotNetClusterId}
  • {ProcessGroup:DotNetNodeId}
  • {ProcessGroup:ElasticsearchClusterName}
  • {ProcessGroup:ElasticsearchNodeName}
  • {ProcessGroup:EquinoxConfigPath}
  • {ProcessGroup:ExeName}
  • {ProcessGroup:ExePath}
  • {ProcessGroup:GlassFishDomainName}
  • {ProcessGroup:GlassFishInstanceName}
  • {ProcessGroup:GoogleAppEngineInstance}
  • {ProcessGroup:GoogleAppEngineService}
  • {ProcessGroup:GoogleCloudProject}
  • {ProcessGroup:HybrisBinDirectory}
  • {ProcessGroup:HybrisConfigDirectory}
  • {ProcessGroup:HybrisConfigDirectory}
  • {ProcessGroup:HybrisDataDirectory}
  • {ProcessGroup:IBMCicsRegion}
  • {ProcessGroup:IBMCtgName}
  • {ProcessGroup:IBMImsConnectRegion}
  • {ProcessGroup:IBMImsControlRegion}
  • {ProcessGroup:IBMImsMessageProcessingRegion}
  • {ProcessGroup:IBMImsSoapGwName}
  • {ProcessGroup:IBMIntegrationNodeName}
  • {ProcessGroup:IBMIntegrationServerName}
  • {ProcessGroup:IISAppPool}
  • {ProcessGroup:IISRoleName}
  • {ProcessGroup:JbossHome}
  • {ProcessGroup:JbossMode}
  • {ProcessGroup:JbossServerName}
  • {ProcessGroup:JavaJarFile}
  • {ProcessGroup:JavaJarPath}
  • {ProcessGroup:JavaMainCLass}
  • {ProcessGroup:KubernetesBasePodName}
  • {ProcessGroup:KubernetesContainerName}
  • {ProcessGroup:KubernetesFullPodName}
  • {ProcessGroup:KubernetesNamespace}
  • {ProcessGroup:KubernetesPodUid}
  • {ProcessGroup:MssqlInstanceName}
  • {ProcessGroup:NodeJsAppBaseDirectory}
  • {ProcessGroup:NodeJsAppName}
  • {ProcessGroup:NodeJsScriptName}
  • {ProcessGroup:OracleSid}
  • {ProcessGroup:PHPScriptPath}
  • {ProcessGroup:PHPWorkingDirectory}
  • {ProcessGroup:Ports}
  • {ProcessGroup:RubyAppRootPath}
  • {ProcessGroup:RubyScriptPath}
  • {ProcessGroup:SoftwareAGInstallRoot}
  • {ProcessGroup:SoftwareAGProductPropertyName}
  • {ProcessGroup:SpringBootAppName}
  • {ProcessGroup:SpringBootProfileName}
  • {ProcessGroup:SpringBootStartupClass}
  • {ProcessGroup:TIBCOBusinessWorksAppNodeName}
  • {ProcessGroup:TIBCOBusinessWorksAppSpaceName}
  • {ProcessGroup:TIBCOBusinessWorksCeAppName}
  • {ProcessGroup:TIBCOBusinessWorksCeVersion}
  • {ProcessGroup:TIBCOBusinessWorksDomainName}
  • {ProcessGroup:TIBCOBusinessWorksEnginePropertyFilePath}
  • {ProcessGroup:TIBCOBusinessWorksEnginePropertyFile}
  • {ProcessGroup:TIBCOBusinessWorksHome}
  • {ProcessGroup:VarnishInstanceName}
  • {ProcessGroup:WebLogicClusterName}
  • {ProcessGroup:WebLogicDomainName}
  • {ProcessGroup:WebLogicHome}
  • {ProcessGroup:WebLogicName}
  • {ProcessGroup:WebSphereCellName}
  • {ProcessGroup:WebSphereClusterName}
  • {ProcessGroup:WebSphereNodeName}
  • {ProcessGroup:WebSphereServerName}
  • {ProcessGroup:ActorSystem}
  • {Service:STGServerName}
  • {Service:DatabaseHostName}
  • {Service:DatabaseName}
  • {Service:DatabaseVendor}
  • {Service:DetectedName}
  • {Service:EndpointPath}
  • {Service:EndpointPathGatewayUrl}
  • {Service:IIBApplicationName}
  • {Service:MessageListenerClassName}
  • {Service:Port}
  • {Service:PublicDomainName}
  • {Service:RemoteEndpoint}
  • {Service:RemoteName}
  • {Service:WebApplicationId}
  • {Service:WebContextRoot}
  • {Service:WebServerName}
  • {Service:WebServiceNamespace}
  • {Service:WebServiceName}
  • {VmwareDatacenter:Name}
  • {VmwareVm:Name}
необязательный
нормализация нить Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS.

Элемент может содержать эти значения

  • LEAVE_TEXT_AS_IS
  • TO_LOWER_CASE
  • TO_UPPER_CASE
необязательный
Типы распространения строка [] Как применить тег к базовым объектам:
  • SERVICE_TO_PROCESS_GROUP_LIKE: применяется к базовым группам процессов соответствующих служб.
  • SERVICE_TO_HOST_LIKE: Применить к базовым узлам соответствующих служб.
  • PROCESS_GROUP_TO_HOST: применяется к базовым хостам соответствующих групп процессов.
  • PROCESS_GROUP_TO_SERVICE: применяется ко всем службам, предоставляемым группами процессов.
  • HOST_TO_PROCESS_GROUP_INSTANCE: применяется к процессам, работающим на соответствующих хостах.
  • AZURE_TO_PG: применяется к группам процессов, подключенным к соответствующим сущностям Azure.
  • AZURE_TO_SERVICE: применять к службам, предоставляемым соответствующими сущностями Azure.

Элемент может содержать эти значения

  • AZURE_TO_PG
  • AZURE_TO_SERVICE
  • HOST_TO_PROCESS_GROUP_INSTANCE
  • PROCESS_GROUP_TO_HOST
  • PROCESS_GROUP_TO_SERVICE
  • SERVICE_TO_HOST_LIKE
  • SERVICE_TO_PROCESS_GROUP_LIKE
необязательный
условия Состояние ядра правила сущности [] Список правил сопоставления для автоматической пометки.

Тег применяется только при выполнении всех условий.

необходимый

Объект _ EntityRuleEngineCondition

Условие определяет, как выполнять логику сопоставления для сущности.

Элемент Тип Описание Необходимый
ключ Ключ условия Ключ для идентификации данных, которые мы сопоставляем.

Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .

необходимый
сравнениеИнформация Основное сравнение Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем.

Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .

необходимый

Объект _ ConditionKey

Ключ для идентификации данных, которые мы сопоставляем.

Фактический набор полей и возможных значений зависит от типа ключа. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .

Элемент Тип Описание Необходимый
атрибут нить Атрибут, который будет использоваться для сравнения.

Элемент может содержать эти значения

  • APPMON_SERVER_NAME
  • APPMON_SYSTEM_PROFILE_NAME
  • AWS_ACCOUNT_ID
  • AWS_ACCOUNT_NAME
  • AWS_APPLICATION_LOAD_BALANCER_NAME
  • AWS_APPLICATION_LOAD_BALANCER_TAGS
  • AWS_AUTO_SCALING_GROUP_NAME
  • AWS_AUTO_SCALING_GROUP_TAGS
  • AWS_AVAILABILITY_ZONE_NAME
  • AWS_CLASSIC_LOAD_BALANCER_FRONTEND_PORTS
  • AWS_CLASSIC_LOAD_BALANCER_NAME
  • AWS_CLASSIC_LOAD_BALANCER_TAGS
  • AWS_NETWORK_LOAD_BALANCER_NAME
  • AWS_NETWORK_LOAD_BALANCER_TAGS
  • AWS_RELATIONAL_DATABASE_SERVICE_DB_NAME
  • AWS_RELATIONAL_DATABASE_SERVICE_ENDPOINT
  • AWS_RELATIONAL_DATABASE_SERVICE_ENGINE
  • AWS_RELATIONAL_DATABASE_SERVICE_INSTANCE_CLASS
  • AWS_RELATIONAL_DATABASE_SERVICE_NAME
  • AWS_RELATIONAL_DATABASE_SERVICE_PORT
  • AWS_RELATIONAL_DATABASE_SERVICE_TAGS
  • AZURE_ENTITY_NAME
  • AZURE_ENTITY_TAGS
  • AZURE_MGMT_GROUP_NAME
  • AZURE_MGMT_GROUP_UUID
  • AZURE_REGION_NAME
  • AZURE_SCALE_SET_NAME
  • AZURE_SUBSCRIPTION_NAME
  • AZURE_SUBSCRIPTION_UUID
  • AZURE_TENANT_NAME
  • AZURE_TENANT_UUID
  • AZURE_VM_NAME
  • BROWSER_MONITOR_NAME
  • BROWSER_MONITOR_TAGS
  • CLOUD_APPLICATION_LABELS
  • CLOUD_APPLICATION_NAME
  • CLOUD_APPLICATION_NAMESPACE_LABELS
  • CLOUD_APPLICATION_NAMESPACE_NAME
  • CLOUD_FOUNDRY_FOUNDATION_NAME
  • CLOUD_FOUNDRY_ORG_NAME
  • CUSTOM_APPLICATION_NAME
  • CUSTOM_APPLICATION_PLATFORM
  • CUSTOM_APPLICATION_TAGS
  • CUSTOM_APPLICATION_TYPE
  • CUSTOM_DEVICE_DETECTED_NAME
  • CUSTOM_DEVICE_DNS_ADDRESS
  • CUSTOM_DEVICE_GROUP_NAME
  • CUSTOM_DEVICE_GROUP_TAGS
  • CUSTOM_DEVICE_IP_ADDRESS
  • CUSTOM_DEVICE_METADATA
  • CUSTOM_DEVICE_NAME
  • CUSTOM_DEVICE_PORT
  • CUSTOM_DEVICE_TAGS
  • CUSTOM_DEVICE_TECHNOLOGY
  • DATA_CENTER_SERVICE_DECODER_TYPE
  • DATA_CENTER_SERVICE_IP_ADDRESS
  • DATA_CENTER_SERVICE_METADATA
  • DATA_CENTER_SERVICE_NAME
  • DATA_CENTER_SERVICE_PORT
  • DATA_CENTER_SERVICE_TAGS
  • DOCKER_CONTAINER_NAME
  • DOCKER_FULL_IMAGE_NAME
  • DOCKER_IMAGE_VERSION
  • DOCKER_STRIPPED_IMAGE_NAME
  • EC2_INSTANCE_AMI_ID
  • EC2_INSTANCE_AWS_INSTANCE_TYPE
  • EC2_INSTANCE_AWS_SECURITY_GROUP
  • EC2_INSTANCE_BEANSTALK_ENV_NAME
  • EC2_INSTANCE_ID
  • EC2_INSTANCE_NAME
  • EC2_INSTANCE_PRIVATE_HOST_NAME
  • EC2_INSTANCE_PUBLIC_HOST_NAME
  • EC2_INSTANCE_TAGS
  • ENTERPRISE_APPLICATION_DECODER_TYPE
  • ENTERPRISE_APPLICATION_IP_ADDRESS
  • ENTERPRISE_APPLICATION_METADATA
  • ENTERPRISE_APPLICATION_NAME
  • ENTERPRISE_APPLICATION_PORT
  • ENTERPRISE_APPLICATION_TAGS
  • ESXI_HOST_CLUSTER_NAME
  • ESXI_HOST_HARDWARE_MODEL
  • ESXI_HOST_HARDWARE_VENDOR
  • ESXI_HOST_NAME
  • ESXI_HOST_PRODUCT_NAME
  • ESXI_HOST_PRODUCT_VERSION
  • ESXI_HOST_TAGS
  • EXTERNAL_MONITOR_ENGINE_DESCRIPTION
  • EXTERNAL_MONITOR_ENGINE_NAME
  • EXTERNAL_MONITOR_ENGINE_TYPE
  • EXTERNAL_MONITOR_NAME
  • EXTERNAL_MONITOR_TAGS
  • GEOLOCATION_SITE_NAME
  • GOOGLE_CLOUD_PLATFORM_ZONE_NAME
  • GOOGLE_COMPUTE_INSTANCE_ID
  • GOOGLE_COMPUTE_INSTANCE_MACHINE_TYPE
  • GOOGLE_COMPUTE_INSTANCE_NAME
  • GOOGLE_COMPUTE_INSTANCE_PROJECT
  • GOOGLE_COMPUTE_INSTANCE_PROJECT_ID
  • GOOGLE_COMPUTE_INSTANCE_PUBLIC_IP_ADDRESSES
  • HOST_AIX_LOGICAL_CPU_COUNT
  • HOST_AIX_SIMULTANEOUS_THREADS
  • HOST_AIX_VIRTUAL_CPU_COUNT
  • HOST_ARCHITECTURE
  • HOST_AWS_NAME_TAG
  • HOST_AZURE_COMPUTE_MODE
  • HOST_AZURE_SKU
  • HOST_AZURE_WEB_APPLICATION_HOST_NAMES
  • HOST_AZURE_WEB_APPLICATION_SITE_NAMES
  • HOST_BITNESS
  • HOST_BOSH_AVAILABILITY_ZONE
  • HOST_BOSH_DEPLOYMENT_ID
  • HOST_BOSH_INSTANCE_ID
  • HOST_BOSH_INSTANCE_NAME
  • HOST_BOSH_NAME
  • HOST_BOSH_STEMCELL_VERSION
  • HOST_CLOUD_TYPE
  • HOST_CPU_CORES
  • HOST_CUSTOM_METADATA
  • HOST_DETECTED_NAME
  • HOST_GROUP_ID
  • HOST_GROUP_NAME
  • HOST_HYPERVISOR_TYPE
  • HOST_IP_ADDRESS
  • HOST_KUBERNETES_LABELS
  • HOST_LOGICAL_CPU_CORES
  • HOST_NAME
  • HOST_ONEAGENT_CUSTOM_HOST_NAME
  • HOST_OS_TYPE
  • HOST_OS_VERSION
  • HOST_PAAS_MEMORY_LIMIT
  • HOST_PAAS_TYPE
  • HOST_TAGS
  • HOST_TECHNOLOGY
  • HTTP_MONITOR_NAME
  • HTTP_MONITOR_TAGS
  • KUBERNETES_CLUSTER_NAME
  • KUBERNETES_NODE_NAME
  • KUBERNETES_SERVICE_NAME
  • MOBILE_APPLICATION_NAME
  • MOBILE_APPLICATION_PLATFORM
  • MOBILE_APPLICATION_TAGS
  • NAME_OF_COMPUTE_NODE
  • OPENSTACK_ACCOUNT_NAME
  • OPENSTACK_ACCOUNT_PROJECT_NAME
  • OPENSTACK_AVAILABILITY_ZONE_NAME
  • OPENSTACK_PROJECT_NAME
  • OPENSTACK_REGION_NAME
  • OPENSTACK_VM_INSTANCE_TYPE
  • OPENSTACK_VM_NAME
  • OPENSTACK_VM_SECURITY_GROUP
  • PROCESS_GROUP_AZURE_HOST_NAME
  • PROCESS_GROUP_AZURE_SITE_NAME
  • PROCESS_GROUP_CUSTOM_METADATA
  • PROCESS_GROUP_DETECTED_NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_LISTEN_PORT
  • PROCESS_GROUP_NAME
  • PROCESS_GROUP_PREDEFINED_METADATA
  • PROCESS_GROUP_TAGS
  • PROCESS_GROUP_TECHNOLOGY
  • PROCESS_GROUP_TECHNOLOGY_EDITION
  • PROCESS_GROUP_TECHNOLOGY_VERSION
  • QUEUE_NAME
  • QUEUE_TECHNOLOGY
  • QUEUE_VENDOR
  • SERVICE_AKKA_ACTOR_SYSTEM
  • SERVICE_CTG_SERVICE_NAME
  • SERVICE_DATABASE_HOST_NAME
  • SERVICE_DATABASE_NAME
  • SERVICE_DATABASE_TOPOLOGY
  • SERVICE_DATABASE_VENDOR
  • SERVICE_DETECTED_NAME
  • SERVICE_ESB_APPLICATION_NAME
  • SERVICE_IBM_CTG_GATEWAY_URL
  • SERVICE_IIB_APPLICATION_NAME
  • SERVICE_MESSAGING_LISTENER_CLASS_NAME
  • SERVICE_NAME
  • SERVICE_PORT
  • SERVICE_PUBLIC_DOMAIN_NAME
  • SERVICE_REMOTE_ENDPOINT
  • SERVICE_REMOTE_SERVICE_NAME
  • SERVICE_TAGS
  • SERVICE_TECHNOLOGY
  • SERVICE_TECHNOLOGY_EDITION
  • SERVICE_TECHNOLOGY_VERSION
  • SERVICE_TOPOLOGY
  • SERVICE_TYPE
  • SERVICE_WEB_APPLICATION_ID
  • SERVICE_WEB_CONTEXT_ROOT
  • SERVICE_WEB_SERVER_ENDPOINT
  • SERVICE_WEB_SERVER_NAME
  • SERVICE_WEB_SERVICE_NAME
  • SERVICE_WEB_SERVICE_NAMESPACE
  • VMWARE_DATACENTER_NAME
  • VMWARE_VM_NAME
  • WEB_APPLICATION_NAME
  • WEB_APPLICATION_NAME_PATTERN
  • WEB_APPLICATION_TAGS
  • WEB_APPLICATION_TYPE
необходимый
тип нить Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • PROCESS_CUSTOM_METADATA_KEY-> CustomProcessMetadataConditionKey
  • HOST_CUSTOM_METADATA_KEY-> CustomHostMetadataConditionKey
  • PROCESS_PREDEFINED_METADATA_KEY-> ProcessMetadataConditionKey
  • STRING-> СтроковыйКлючУсловия
  • STATIC-> СтатикКондишнКей

Элемент может содержать эти значения

  • HOST_CUSTOM_METADATA_KEY
  • PROCESS_CUSTOM_METADATA_KEY
  • PROCESS_PREDEFINED_METADATA_KEY
  • STATIC
  • STRING
необязательный

Объект _ ComparisonBasic

Определяет, как на самом деле выполняется сопоставление: что и как мы сравниваем.

Фактический набор полей и возможные значения поля оператора зависят от типа сравнения. Список актуальных объектов ищите в описании поля типа или смотрите модели JSON .

Элемент Тип Описание Необходимый
оператор нить Оператор сравнения. Вы можете изменить его, установив отрицание в true.

Возможные значения зависят от типа сравнения. Найдите список актуальных моделей в описании поля типа и проверьте описание нужной вам модели.

необходимый
ценить объект Значение для сравнения. необязательный
отрицать логический Отменяет оператор сравнения . Например, он превращает начинается с в не начинается с . необходимый
тип нить Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • STRING-> Сравнение строк
  • INDEXED_NAME-> Сравнение индексированных имен
  • INDEXED_STRING-> Сравнение индексированных строк
  • INTEGER-> Целочисленное сравнение
  • SERVICE_TYPE-> Сравнение типов служб
  • PAAS_TYPE-> Сравнение пасхальных типов
  • CLOUD_TYPE-> Сравнение облачных типов
  • AZURE_SKU-> Сравнение AzureSku
  • AZURE_COMPUTE_MODE-> Сравнение AzureComputeModeComparison
  • ENTITY_ID-> Сравнение идентификаторов объектов
  • SIMPLE_TECH-> Сравнение простых технологий
  • SIMPLE_HOST_TECH-> Сравнение SimpleHostTech
  • SERVICE_TOPOLOGY-> Сравнение топологии служб
  • DATABASE_TOPOLOGY-> Сравнение топологии баз данных
  • OS_TYPE-> Сравнение типов ос
  • HYPERVISOR_TYPE-> Сравнение типов гипервизора
  • IP_ADDRESS-> Сравнение IP-адресов
  • OS_ARCHITECTURE-> Сравнение ОС
  • BITNESS-> Сравнение битности
  • APPLICATION_TYPE-> Сравнение типов приложений
  • MOBILE_PLATFORM-> Сравнение мобильных платформ
  • CUSTOM_APPLICATION_TYPE-> Сравнение пользовательских типов приложений
  • DCRUM_DECODER_TYPE-> Сравнение декодеров Dcrum
  • SYNTHETIC_ENGINE_TYPE-> Сравнение синтетических движков
  • TAG-> Сравнение тегов
  • INDEXED_TAG-> Сравнение индексированных тегов

Элемент может содержать эти значения

необходимый

Объект _ EntitySelectorBasedAutoTagRule

Основанное на селекторе объектов правило для автоматического использования тегов. Он позволяет помечать объекты с помощью селектора объектов.

Элемент Тип Описание Необходимый
включено логический Правило включено ( true) или отключено ( false). необязательный
селектор объектов нить Строка селектора объектов, по которой выбираются объекты. необходимый
формат значения нить Значение автотега на основе селектора объектов. Если указано, тег используется в name:valueFormatформате.

Например, вы можете расширить Infrastructureтег до Infrastructure:Windowsи Infrastructure:Linux.

необязательный
нормализация нить Изменения, примененные к значению после применения формата значения. По умолчанию LEAVE_TEXT_AS_IS.

Элемент может содержать эти значения

  • LEAVE_TEXT_AS_IS
  • TO_LOWER_CASE
  • TO_UPPER_CASE
необязательный

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 Краткое представление объекта Успех. Новый автотег создан. Тело ответа содержит идентификатор нового автотега.
204 Успех. Автотег обновлен. Ответ не имеет тела.
400 ErrorEnvelope Неуспешный. Ввод недействителен.

Объекты тела ответа

Объект _ EntityShortRepresentation

Краткое представление объекта Ключ-АСТРОМ.

Элемент Тип Описание
идентификатор нить Идентификатор объекта Ключ-АСТРОМ.
имя нить Имя объекта Ключ-АСТРОМ.
описание нить Краткое описание сущности Ключ-АСТРОМ.

JSON-модель тела ответа

{
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Astromkey entity",
  "description": "Astromkey entity for the REST API example"
}

Проверить полезную нагрузку

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

Запрос потребляет application/jsonполезную нагрузку.

ПОЧТА УдалосьКлюч-АСТРОМ для правительства https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}/validator
Окружающая среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/autoTags/{id}/validator

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. WriteConfig

Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Ответ

Коды ответов

Код Тип Описание
204 Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.
400 ErrorEnvelope Неуспешный. Ввод недействителен.

Пример

В этом примере запрос обновляет автотег Инфраструктура — Linux из примера запроса GET .

Начальная конфигурация следующая:

Запрос добавляет дополнительное условие к существующему правилу для значения тега prod , дополнительно требуя, чтобы имя группы хостов содержало production.

Он также добавляет новое правило, которое присваивает значение тега preProd для хостов Linux с именами, начинающимися с PreProd .

Маркер API передается в заголовке авторизации .

Тело запроса длинное, поэтому оно усекается в разделе Curl . Полное тело см. в разделе Тело запроса . Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно.

Завиток

curl -X PUT \
  https://mySampleEnv.live.ruscomtech.ru/api/config/v1/autoTags/7c82c170-b380-4fa7-992a-453f3e73047b \
  -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/7c82c170-b380-4fa7-992a-453f3e73047b

Тело запроса

{
  "name": "Infrastructure - Linux",
  "rules": [
    {
      "type": "HOST",
      "enabled": true,
      "valueFormat": "prod",
      "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
          }
        },
        {
          "key": {
            "attribute": "HOST_GROUP_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "CONTAINS",
            "value": "production",
            "negate": false,
            "caseSensitive": true
          }
        }
      ]
    },
    {
      "type": "HOST",
      "enabled": true,
      "valueFormat": "preProd",
      "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": false,
            "caseSensitive": true
          }
        }
      ]
    }
  ]
}

Код ответа

204

Результат

Обновленный автотег имеет следующие параметры: