Просмотр кода страницы Обнаружение аномалий событий метрик API - GET событие

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

Запрос создает в качестве полезной нагрузки<code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/metricEvents/{id}</nowiki></code>
|-
|Среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/metricEvents/{id}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигурации ( <code>ReadConfig</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|id
|string
|Идентификатор требуемого события метрики.
|path
|требуется
|}

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

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|MetricEvent
|Успех
|}

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

==== Объект <code>MetricEvent</code> ====
Конфигурация события метрики.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|metadata
|ConfigurationMetadata
|Метаданные, полезные для отладки
|-
|id
|string
|Идентификатор события метрики.
|-
|metricId
|string
|Идентификатор метрики, оцениваемой событием метрики.
|-
|metricSelector
|string
|Селектор метрик, который должен быть выполнен.
|-
|name
|string
|Имя события метрики, отображаемое в пользовательском интерфейсе.
|-
|description
|string
|Описание события метрики.
|-
|aggregationType
|string
|Как точки данных метрики агрегируются для оценки.

Временные ряды должны поддерживать эту агрегацию.

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

* <code>AVG</code>
* <code>COUNT</code>
* <code>MAX</code>
* <code>MEDIAN</code>
* <code>MIN</code>
* <code>P90</code>
* <code>SUM</code>
* <code>VALUE</code>
|-
|severity
|string
|Тип события, которое инициируется при нарушении порогового значения.

Тип <code>CUSTOM_ALERT</code>не связан с другими оповещениями. <code>INFO</code>Типа проблема не открывается .

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

* <code>AVAILABILITY</code>
* <code>CUSTOM_ALERT</code>
* <code>ERROR</code>
* <code>INFO</code>
* <code>PERFORMANCE</code>
* <code>RESOURCE_CONTENTION</code>
|-
|enabled
|boolean
|Событие метрики включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|disabledReason
|string
|Причина автоматического отключения.

Конфигурация <code>NONE</code>означает, что она не была отключена автоматически.

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

* <code>METRIC_DEFINITION_INCONSISTENCY</code>
* <code>NONE</code>
* <code>TOO_MANY_DIMS</code>
* <code>TOPX_FORCIBLY_DEACTIVATED</code>
|-
|warningReason
|string
|Причина предупреждения указана в конфиге.

В <code>NONE</code>конфигурации средств нет предупреждений.

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

* <code>NONE</code>
* <code>TOO_MANY_DIMS</code>
|-
|alertingScope
|MetricEventAlertingScope[]
|Определяет область действия метрики. Допускается только один фильтр для каждого типа фильтра, за исключением тегов, где разрешено до 3. Фильтры объединяются конъюнкцией.
|-
|metricDimensions
|MetricEventDimensions[]
|Определяет параметры метрики для оповещения. Фильтры объединяются конъюнкцией.
|-
|monitoringStrategy
|MetricEventMonitoringStrategy
|Стратегия мониторинга для конфигурации события метрики.

Это базовая версия стратегии мониторинга, в зависимости от типа актуальный JSON может содержать дополнительные поля.
|-
|primaryDimensionKey
|string
|Определяет, какой ключ измерения следует использовать для alertingScope .
|-
|queryOffset
|integer
|Определяет смещение запроса для адаптации временных рамок оценки к известной задержке метрики.
|}

==== Объект <code>ConfigurationMetadata</code> ====
Метаданные, полезные для отладки
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|configurationVersions
|integer[]
|Отсортированный список номеров версий конфигурации.
|-
|currentConfigurationVersions
|string[]
|Отсортированный список номеров версий конфигурации.
|-
|clusterVersion
|string
|Версия Dynatrace.
|}

==== Объект <code>MetricEventAlertingScope</code> ====
Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|filterType
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>ENTITY_ID</code>-> EntityIdAlertingScope
* <code>MANAGEMENT_ZONE</code>-> ManagementZoneAlertingScope
* <code>TAG</code>-> TagFilterAlertingScope
* <code>NAME</code>-> NameAlertingScope
* <code>CUSTOM_DEVICE_GROUP_NAME</code>-> CustomDeviceGroupNameAlertingScope
* <code>HOST_GROUP_NAME</code>-> HostGroupNameAlertingScope
* <code>HOST_NAME</code>-> HostNameAlertingScope
* <code>PROCESS_GROUP_ID</code>-> ProcessGroupIdAlertingScope
* <code>PROCESS_GROUP_NAME</code>-> ProcessGroupNameAlertingScope

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

* <code>CUSTOM_DEVICE_GROUP_NAME</code>
* <code>ENTITY_ID</code>
* <code>HOST_GROUP_NAME</code>
* <code>HOST_NAME</code>
* <code>MANAGEMENT_ZONE</code>
* <code>NAME</code>
* <code>PROCESS_GROUP_ID</code>
* <code>PROCESS_GROUP_NAME</code>
* <code>TAG</code>
|}

==== Объект <code>MetricEventDimensions</code> ====
Единый фильтр для измерений показателей.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|filterType
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>ENTITY</code>-> МетрикаEventEntityDimensions
* <code>STRING</code>-> MetricEventStringDimensions

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

* <code>ENTITY</code>
* <code>STRING</code>
|-
|key
|string
|Ключ размеров на метрике.
|}

==== Объект <code>MetricEventMonitoringStrategy</code> ====
Стратегия мониторинга для конфигурации события метрики.

Это базовая версия стратегии мониторинга, в зависимости от типа актуальный JSON может содержать дополнительные поля.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>STATIC_THRESHOLD</code>-> MetricEventStaticThresholdMonitoringStrategy
* <code>AUTO_ADAPTIVE_BASELINE</code>-> MetricEventAutoAdaptiveBaselineMonitoringStrategy

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

* <code>AUTO_ADAPTIVE_BASELINE</code>
* <code>STATIC_THRESHOLD</code>
|}

=== JSON-модель тела ответа ===
 <code>{
   "metadata": {
     "configurationVersions": [
       4,
       2
     ],
     "clusterVersion": "Mock version"
   },
   "metricId": "com.dynatrace.builtin:host.disk.bytesread",
   "name": "My metric event",
   "description": "This is the description for my metric event.",
   "aggregationType": "AVG",
   "severity": "CUSTOM_ALERT",
   "alertingScope": [
     {
       "filterType": "ENTITY_ID",
       "entityId": "HOST-000000000001E240"
     },
     {
       "filterType": "TAG",
       "tagFilter": {
         "context": "CONTEXTLESS",
         "key": "someKey",
         "value": "someValue"
       }
     }
   ],
   "metricDimensions": [
     {
       "filterType": "ENTITY",
       "key": "dt.entity.disk",
       "nameFilter": {
         "value": "diskName",
         "operator": "EQUALS"
       }
     }
   ],
   "enabled": true,
   "disabledReason": "NONE",
   "warningReason": "NONE",
   "monitoringStrategy": {
     "type": "STATIC_THRESHOLD",
     "alertCondition": "ABOVE",
     "samples": 5,
     "violatingSamples": 3,
     "dealertingSamples": 5,
     "threshold": 80,
     "unit": "KILO_BYTE_PER_SECOND"
   }
 }</code>

== Пример ==
В этом примере в запросе перечислены параметры пользовательского правила события метрики « Высокая загрузка ЦП ОС ».

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

Правило имеет следующие параметры:

[[Файл:metric-events1.png]]

==== Curl ====
 <code>curl -X GET \
   https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents/dynatrace<nowiki/>.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
 <code>https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents/dynatrace<nowiki/>.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage</code>

==== Тело ответа ====
 <code>{
   "metadata": {
     "clusterVersion": "1.164.0.20190211-085949",
     "configurationVersions": [
       2
     ]
   },
   "id": "dynatrace.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage",
   "metricId": "dynatrace.remote.python.elasticsearch:node.os.cpu_percent",
   "name": "High OS CPU usage",
   "description": "The OS CPU usage is {alert_condition} the threshold of {threshold}",
   "aggregationType": "AVG",
   "eventType": "PERFORMANCE",
   "alertCondition": "ABOVE",
   "samples": 5,
   "violatingSamples": 3,
   "dealertingSamples": 5,
   "threshold": 70,
   "enabled": true,
   "tagFilters": []
 }</code>

==== Код ответа ====
200