JSON-модели: различия между версиями

Материал из Dynatrace
(Новая страница: «Некоторые модели JSON для API Problems v2 различаются в зависимости от типа модели. Модели JSON для...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 4: Строка 4:
Объект <code>Evidence</code>является основой для доказательства проблемы. Фактический набор полей зависит от типа свидетельства.
Объект <code>Evidence</code>является основой для доказательства проблемы. Фактический набор полей зависит от типа свидетельства.


=== ДОСТУПНОСТЬ_EVIDENCE ===
=== AVAILABILITY_EVIDENCE ===
ДоступностьДоказательстваМетаданные
<u>AvailabilityEvidenceMetadata</u>


==== Объект _ <code>AvailabilityEvidence</code> ====
'''Параметры:'''
 
==== Объект <code>AvailabilityEvidence</code> ====
Доказательство первопричины.
Доказательство первопричины.


Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 16: Строка 18:
!Описание
!Описание
|-
|-
|время окончания
|endTime
|целое число
|integer
|Время окончания свидетельства в миллисекундах UTC.
|Время окончания свидетельства в миллисекундах UTC.
|}
|}
'''JSON модель:'''
<code>{
  "evidenceType": "AVAILABILITY_EVIDENCE",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "endTime": 1602600000000
}</code>
=== EVENT ===
<u>EventEvidenceMetadata</u>


=== МЕРОПРИЯТИЕ ===
'''Параметры:'''
EventEvidenceMetadata


==== Объект _ <code>EventEvidence</code> ====
==== Объект <code>EventEvidence</code> ====
Доказательство первопричины.
Доказательство первопричины.


Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 33: Строка 59:
!Описание
!Описание
|-
|-
|идентификатор события
|eventId
|нить
|string
|Идентификатор события.
|Идентификатор события.
|-
|-
|данные
|data
|Мероприятие
|Event
|Конфигурация события.
|Конфигурация события.
|-
|-
|тип события
|eventType
|нить
|string
|Тип события.
|Тип события.
|-
|-
|время окончания
|endTime
|целое число
|integer
|Отметка времени окончания события в миллисекундах UTC.
|Отметка времени окончания события в миллисекундах UTC.


Строка 52: Строка 78:
|}
|}


==== Объект _ <code>Event</code> ====
==== Объект <code>Event</code> ====
Конфигурация события.
Конфигурация события.
{| class="wikitable"
{| class="wikitable"
Строка 59: Строка 85:
!Описание
!Описание
|-
|-
|частособытие
|frequentEvent
|логический
|boolean
|Если <code>true</code>, событие происходит часто .
|Если <code>true</code>, событие происходит часто .


Частое событие не вызывает проблем.
Частое событие не вызывает проблем.
|-
|-
|подавлятьпроблему
|suppressProblem
|логический
|boolean
|Статус обнаружения проблемы во время технического обслуживания :
|Статус обнаружения проблемы во время технического обслуживания :


Строка 72: Строка 98:
* <code>true</code>: обнаружение проблем отключено.
* <code>true</code>: обнаружение проблем отключено.
|-
|-
|подавлять оповещение
|suppressAlert
|логический
|boolean
|Состояние предупреждения во время технического обслуживания :
|Состояние предупреждения во время технического обслуживания :


Строка 79: Строка 105:
* <code>true</code>: Оповещение отключено.
* <code>true</code>: Оповещение отключено.
|-
|-
|на техобслуживании
|underMaintenance
|логический
|boolean
|Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании.
|Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании.
|-
|-
|управлениеЗоны
|managementZones
|Зона управления []
|ManagementZone[]
|Список всех зон управления, которым принадлежит событие.
|Список всех зон управления, которым принадлежит событие.
|-
|-
|идентификатор сущности
|entityId
|Заглушка сущности
|EntityStub
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|идентификатор события
|eventId
|нить
|string
|Идентификатор события.
|Идентификатор события.
|-
|-
|сущностьТеги
|entityTags
|М Е тег []
|METag[]
|Список тегов связанного объекта.
|Список тегов связанного объекта.
|-
|-
|тип события
|eventType
|нить
|string
|Тип события.
|Тип события.
|-
|-
|характеристики
|properties
|Свойство события []
|EventProperty[]
|Список свойств события.
|Список свойств события.
|-
|-
|статус
|status
|нить
|string
|Статус события.
|Статус события.


Строка 116: Строка 142:
* <code>OPEN</code>
* <code>OPEN</code>
|-
|-
|время начала
|startTime
|целое число
|integer
|Отметка времени возникновения события в миллисекундах UTC.
|Отметка времени возникновения события в миллисекундах UTC.
|-
|-
|время окончания
|endTime
|целое число
|integer
|Отметка времени закрытия события в миллисекундах UTC.
|Отметка времени закрытия события в миллисекундах UTC.


Имеет значение, <code>null</code>если событие все еще активно.
Имеет значение, <code>null</code>если событие все еще активно.
|-
|-
|заглавие
|title
|нить
|string
|Название события.
|Название события.
|-
|-
|идентификатор корреляции
|correlationId
|нить
|string
|Идентификатор корреляции события.
|Идентификатор корреляции события.
|}
|}


==== Объект _ <code>ManagementZone</code> ====
==== Объект <code>ManagementZone</code> ====
Краткое представление зоны управления.
Краткое представление зоны управления.
{| class="wikitable"
{| class="wikitable"
Строка 142: Строка 168:
!Описание
!Описание
|-
|-
|имя
|name
|нить
|string
|Имя зоны управления.
|Имя зоны управления.
|-
|-
|я бы
|id
|нить
|string
|Идентификатор зоны управления.
|Идентификатор зоны управления.
|}
|}


==== Объект _ <code>EntityStub</code> ====
==== Объект <code>EntityStub</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 158: Строка 184:
!Описание
!Описание
|-
|-
|идентификатор сущности
|entityId
|Идентификатор объекта
|EntityId
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|имя
|name
|нить
|string
|Имя сущности.
|Имя сущности.


Строка 169: Строка 195:
|}
|}


==== Объект _ <code>EntityId</code> ====
==== Объект <code>EntityId</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 176: Строка 202:
!Описание
!Описание
|-
|-
|я бы
|id
|нить
|string
|Идентификатор сущности.
|Идентификатор сущности.
|-
|-
|тип
|type
|нить
|string
|Тип сущности.
|Тип сущности.
|}
|}


==== Объект _ <code>METag</code> ====
==== Объект <code>METag</code> ====
Тег отслеживаемого объекта.
Тег отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 192: Строка 218:
!Описание
!Описание
|-
|-
|представление строки
|stringRepresentation
|нить
|string
|Строковое представление тега.
|Строковое представление тега.
|-
|-
|ценность
|value
|нить
|string
|Значение тега.
|Значение тега.
|-
|-
|ключ
|key
|нить
|string
|Ключ тега.
|Ключ тега.
|-
|-
|контекст
|context
|нить
|string
|Происхождение тега, например AWS или Cloud Foundry.
|Происхождение тега, например AWS или Cloud Foundry.


Строка 211: Строка 237:
|}
|}


==== Объект _ <code>EventProperty</code> ====
==== Объект <code>EventProperty</code> ====
Свойство события.
Свойство события.
{| class="wikitable"
{| class="wikitable"
Строка 218: Строка 244:
!Описание
!Описание
|-
|-
|ценность
|value
|нить
|string
|Значение свойства события.
|Значение свойства события.
|-
|-
|ключ
|key
|нить
|string
|Ключ свойства события.
|Ключ свойства события.
|}
|}
'''JSON модель:'''
<code>{
  "evidenceType": "EVENT",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602511312869,
  "eventId": "string",
  "eventType": "string"
}</code>


=== MAINTENANCE_WINDOW ===
=== MAINTENANCE_WINDOW ===
Метаданные MaintenanceWindowEvidence
<u>Метаданные MaintenanceWindowEvidence</u>


==== Объект _ <code>MaintenanceWindowEvidence</code> ====
'''Параметры:'''
 
==== Объект <code>MaintenanceWindowEvidence</code> ====
Доказательство первопричины.
Доказательство первопричины.


Строка 239: Строка 290:
!Описание
!Описание
|-
|-
|техническое обслуживаниеWindowConfigId
|maintenanceWindowConfigId
|нить
|string
|Идентификатор соответствующего периода обслуживания.
|Идентификатор соответствующего периода обслуживания.
|-
|-
|время окончания
|endTime
|целое число
|integer
|Время окончания свидетельства в миллисекундах UTC.
|Время окончания свидетельства в миллисекундах UTC.
|}
|}
'''JSON модель:'''
<code>{
  "evidenceType": "MAINTENANCE_WINDOW",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "maintenanceWindowConfigId": "string",
  "endTime": 1602600000000
}</code>
=== METRIC ===
<u>MetricEvidenceMetadata</u>


=== МЕТРИЧЕСКАЯ ===
'''Параметры:'''
MetricEvidenceMetadata


==== Объект _ <code>MetricEvidence</code> ====
==== Объект<code>MetricEvidence</code> ====
Доказательство первопричины.
Доказательство первопричины.


Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 260: Строка 336:
!Описание
!Описание
|-
|-
|значениеBeforeChangePoint
|valueBeforeChangePoint
|количество
|number
|Значение метрики до возникновения проблемы.
|Значение метрики до возникновения проблемы.
|-
|-
|значениеАфтерчанжепоинт
|valueAfterChangePoint
|количество
|number
|Значение метрики после начала проблемы.
|Значение метрики после начала проблемы.
|-
|-
|идентификатор метрики
|metricId
|нить
|string
|Идентификатор метрики.
|Идентификатор метрики.
|-
|-
|время окончания
|endTime
|целое число
|integer
|Время окончания свидетельства в миллисекундах UTC.
|Время окончания свидетельства в миллисекундах UTC.


Значение <code>null</code>указывает, что свидетельство все еще открыто.
Значение <code>null</code>указывает, что свидетельство все еще открыто.
|-
|-
|Ед. изм
|unit
|нить
|string
|Единица измерения.
|Единица измерения.


Строка 346: Строка 422:
* <code>Year</code>
* <code>Year</code>
|}
|}
'''JSON модель:'''
<code>{
  "evidenceType": "METRIC",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "metricId": "string",
  "valueBeforeChangePoint": 2,
  "valueAfterChangePoint": 3,
  "unit": "Count",
  "endTime": 1602600000000
}</code>


=== ТРАНЗАКЦИОННЫЙ ===
=== TRANSACTIONAL ===
TransactionalEvidenceMetadata
<u>TransactionalEvidenceMetadata</u>
 
'''Параметры:'''


==== Объект _ <code>TransactionalEvidence</code> ====
==== Объект _ <code>TransactionalEvidence</code> ====
Строка 359: Строка 463:
!Описание
!Описание
|-
|-
|значениеBeforeChangePoint
|valueBeforeChangePoint
|количество
|number
|Значение метрики до возникновения проблемы.
|Значение метрики до возникновения проблемы.
|-
|-
|значениеАфтерчанжепоинт
|valueAfterChangePoint
|количество
|number
|Значение метрики после начала проблемы.
|Значение метрики после начала проблемы.
|-
|-
|время окончания
|endTime
|целое число
|integer
|Время окончания свидетельства, в миллисекундах UTC
|Время окончания свидетельства, в миллисекундах UTC
|-
|-
|Ед. изм
|unit
|нить
|string
|Единица измерения.
|Единица измерения.
|}
|}
'''JSON модель:'''
<code>{
  "evidenceType": "TRANSACTIONAL",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "valueBeforeChangePoint": 2,
  "valueAfterChangePoint": 3,
  "unit": "Count",
  "endTime": 1602600000000
}</code>


== Вариации <code>Impact</code>объекта ==
== Вариации <code>Impact</code>объекта ==
Объект <code>Impact</code>является базой для воздействия проблемы. Фактический набор полей зависит от типа воздействия.
Объект <code>Impact</code>является базой для воздействия проблемы. Фактический набор полей зависит от типа воздействия.


=== ЗАЯВЛЕНИЕ ===
=== APPLICATION ===
ApplicationImpactDto
<u>ApplicationImpactDto</u>
 
'''Параметры:'''


==== Объект _ <code>ApplicationImpact</code> ====
==== Объект <code>ApplicationImpact</code> ====
Анализ воздействия проблемы на другие объекты/пользователей.
Анализ воздействия проблемы на другие объекты/пользователей.


Строка 391: Строка 522:
!Описание
!Описание
|-
|-
|ударТип
|impactType
|нить
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:


Строка 407: Строка 538:
* <code>SERVICE</code>
* <code>SERVICE</code>
|-
|-
|воздействующий объект
|impactedEntity
|Заглушка сущности
|EntityStub
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|предполагаемые затронутые пользователи
|estimatedAffectedUsers
|целое число
|integer
|Предполагаемое количество затронутых пользователей.
|Предполагаемое количество затронутых пользователей.
|}
|}


==== Объект _ <code>EntityStub</code> ====
==== Объект <code>EntityStub</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 423: Строка 554:
!Описание
!Описание
|-
|-
|идентификатор сущности
|entityId
|Идентификатор объекта
|EntityId
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|имя
|name
|нить
|string
|Имя сущности.
|Имя сущности.


Строка 434: Строка 565:
|}
|}


==== Объект _ <code>EntityId</code> ====
==== Объект <code>EntityId</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 441: Строка 572:
!Описание
!Описание
|-
|-
|я бы
|id
|нить
|string
|Идентификатор сущности.
|Идентификатор сущности.
|-
|-
|тип
|type
|нить
|string
|Тип сущности.
|Тип сущности.
|}
|}
'''JSON модель:'''
<code>{
  "impactType": "APPLICATION",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5
}</code>


=== CUSTOM_APPLICATION ===
=== CUSTOM_APPLICATION ===
CustomApplicationImpactDto
<u>CustomApplicationImpactDto</u>
 
'''Параметры:'''


==== Объект _ <code>CustomApplicationImpact</code> ====
==== Объект <code>CustomApplicationImpact</code> ====
Анализ воздействия проблемы на другие объекты/пользователей.
Анализ воздействия проблемы на другие объекты/пользователей.


Строка 462: Строка 607:
!Описание
!Описание
|-
|-
|ударТип
|impactType
|нить
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:


Строка 478: Строка 623:
* <code>SERVICE</code>
* <code>SERVICE</code>
|-
|-
|воздействующий объект
|impactedEntity
|Заглушка сущности
|EntityStub
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|предполагаемые затронутые пользователи
|estimatedAffectedUsers
|целое число
|integer
|Предполагаемое количество затронутых пользователей.
|Предполагаемое количество затронутых пользователей.
|}
|}


==== Объект _ <code>EntityStub</code> ====
==== Объект <code>EntityStub</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 494: Строка 639:
!Описание
!Описание
|-
|-
|идентификатор сущности
|entityId
|Идентификатор объекта
|EntityId
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|имя
|name
|нить
|string
|Имя сущности.
|Имя сущности.


Строка 505: Строка 650:
|}
|}


==== Объект _ <code>EntityId</code> ====
==== Объект <code>EntityId</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 512: Строка 657:
!Описание
!Описание
|-
|-
|я бы
|id
|нить
|string
|Идентификатор сущности.
|Идентификатор сущности.
|-
|-
|тип
|type
|нить
|string
|Тип сущности.
|Тип сущности.
|}
|}
'''JSON модель:'''
<code>{
  "impactType": "CUSTOM_APPLICATION",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5
}</code>


=== МОБИЛЬНЫЙ ===
=== MOBILE ===
MobileImpactDto
<u>MobileImpactDto</u>


==== Объект _ <code>MobileImpact</code> ====
'''Параметры:'''
 
==== Объект <code>MobileImpact</code> ====
Анализ воздействия проблемы на другие объекты/пользователей.
Анализ воздействия проблемы на другие объекты/пользователей.


Строка 533: Строка 692:
!Описание
!Описание
|-
|-
|ударТип
|impactType
|нить
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:


Строка 549: Строка 708:
* <code>SERVICE</code>
* <code>SERVICE</code>
|-
|-
|воздействующий объект
|impactedEntity
|Заглушка сущности
|EntityStub
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|предполагаемые затронутые пользователи
|estimatedAffectedUsers
|целое число
|integer
|Предполагаемое количество затронутых пользователей.
|Предполагаемое количество затронутых пользователей.
|}
|}


==== Объект _ <code>EntityStub</code> ====
==== Объект <code>EntityStub</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 565: Строка 724:
!Описание
!Описание
|-
|-
|идентификатор сущности
|entityId
|Идентификатор объекта
|EntityId
|Краткое представление отслеживаемого объекта.
|Краткое представление отслеживаемого объекта.
|-
|-
|имя
|name
|нить
|string
|Имя сущности.
|Имя сущности.


Строка 576: Строка 735:
|}
|}


==== Объект _ <code>EntityId</code> ====
==== Объект <code>EntityId</code> ====
Краткое представление отслеживаемого объекта.
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
Строка 583: Строка 742:
!Описание
!Описание
|-
|-
|я бы
|id
|нить
|string
|Идентификатор сущности.
|Идентификатор сущности.
|-
|-
|тип
|type
|нить
|string
|Тип сущности.
|Тип сущности.
|}
|}
'''JSON модель:'''
<code>{
  "impactType": "MOBILE",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5
}</code>
=== SERVICE ===
<u>ServiceImpactDto</u>


=== ОКАЗАНИЕ УСЛУГ ===
'''Параметры:'''
ServiceImpactDto


==== Объект _ <code>ServiceImpact</code> ====
==== Объект <code>ServiceImpact</code> ====
Анализ воздействия проблемы на другие объекты/пользователей.
Анализ воздействия проблемы на другие объекты/пользователей.


Строка 605: Строка 778:
|-
|-
|numberOfPotentiallyAffectedServiceCalls
|numberOfPotentiallyAffectedServiceCalls
|целое число
|integer
|Количество потенциально затронутых сервисов.
|Количество потенциально затронутых сервисов.
|}
|}
'''JSON модель:'''
<code>{
  "impactType": "SERVICE",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5,
  "numberOfPotentiallyAffectedServiceCalls": 50
}</code>

Текущая версия на 07:40, 17 октября 2022

Некоторые модели JSON для API Problems v2 различаются в зависимости от типа модели. Модели JSON для каждого варианта перечислены ниже.

Вариации Evidenceобъекта

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

AVAILABILITY_EVIDENCE

AvailabilityEvidenceMetadata

Параметры:

Объект AvailabilityEvidence

Доказательство первопричины.

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
endTime integer Время окончания свидетельства в миллисекундах UTC.

JSON модель:

{
  "evidenceType": "AVAILABILITY_EVIDENCE",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "endTime": 1602600000000
}

EVENT

EventEvidenceMetadata

Параметры:

Объект EventEvidence

Доказательство первопричины.

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
eventId string Идентификатор события.
data Event Конфигурация события.
eventType string Тип события.
endTime integer Отметка времени окончания события в миллисекундах UTC.

Имеет -1значение, если событие все еще активно.

Объект Event

Конфигурация события.

Элемент Тип Описание
frequentEvent boolean Если true, событие происходит часто .

Частое событие не вызывает проблем.

suppressProblem boolean Статус обнаружения проблемы во время технического обслуживания :
  • false: Обнаружение проблем работает как обычно.
  • true: обнаружение проблем отключено.
suppressAlert boolean Состояние предупреждения во время технического обслуживания :
  • false: Оповещение работает как обычно.
  • true: Оповещение отключено.
underMaintenance boolean Если true, событие произошло, когда отслеживаемая система находилась на обслуживании.
managementZones ManagementZone[] Список всех зон управления, которым принадлежит событие.
entityId EntityStub Краткое представление отслеживаемого объекта.
eventId string Идентификатор события.
entityTags METag[] Список тегов связанного объекта.
eventType string Тип события.
properties EventProperty[] Список свойств события.
status string Статус события.

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

  • CLOSED
  • OPEN
startTime integer Отметка времени возникновения события в миллисекундах UTC.
endTime integer Отметка времени закрытия события в миллисекундах UTC.

Имеет значение, nullесли событие все еще активно.

title string Название события.
correlationId string Идентификатор корреляции события.

Объект ManagementZone

Краткое представление зоны управления.

Элемент Тип Описание
name string Имя зоны управления.
id string Идентификатор зоны управления.

Объект EntityStub

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
entityId EntityId Краткое представление отслеживаемого объекта.
name string Имя сущности.

Не включается в ответ, если сущность с соответствующим идентификатором не найдена.

Объект EntityId

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
id string Идентификатор сущности.
type string Тип сущности.

Объект METag

Тег отслеживаемого объекта.

Элемент Тип Описание
stringRepresentation string Строковое представление тега.
value string Значение тега.
key string Ключ тега.
context string Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это CONTEXTLESSзначение.

Объект EventProperty

Свойство события.

Элемент Тип Описание
value string Значение свойства события.
key string Ключ свойства события.

JSON модель:

{
  "evidenceType": "EVENT",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602511312869,
  "eventId": "string",
  "eventType": "string"
}

MAINTENANCE_WINDOW

Метаданные MaintenanceWindowEvidence

Параметры:

Объект MaintenanceWindowEvidence

Доказательство первопричины.

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
maintenanceWindowConfigId string Идентификатор соответствующего периода обслуживания.
endTime integer Время окончания свидетельства в миллисекундах UTC.

JSON модель:

{
  "evidenceType": "MAINTENANCE_WINDOW",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "maintenanceWindowConfigId": "string",
  "endTime": 1602600000000
}

METRIC

MetricEvidenceMetadata

Параметры:

ОбъектMetricEvidence

Доказательство первопричины.

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
valueBeforeChangePoint number Значение метрики до возникновения проблемы.
valueAfterChangePoint number Значение метрики после начала проблемы.
metricId string Идентификатор метрики.
endTime integer Время окончания свидетельства в миллисекундах UTC.

Значение nullуказывает, что свидетельство все еще открыто.

unit string Единица измерения.

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

  • Billion
  • Bit
  • BitPerHour
  • BitPerMinute
  • BitPerSecond
  • Byte
  • BytePerHour
  • BytePerMinute
  • BytePerSecond
  • Cores
  • Count
  • Day
  • DecibelMilliWatt
  • GibiByte
  • Giga
  • GigaByte
  • Hour
  • KibiByte
  • KibiBytePerHour
  • KibiBytePerMinute
  • KibiBytePerSecond
  • Kilo
  • KiloByte
  • KiloBytePerHour
  • KiloBytePerMinute
  • KiloBytePerSecond
  • KiloMetrePerHour
  • MSU
  • MebiByte
  • MebiBytePerHour
  • MebiBytePerMinute
  • MebiBytePerSecond
  • Mega
  • MegaByte
  • MegaBytePerHour
  • MegaBytePerMinute
  • MegaBytePerSecond
  • MetrePerHour
  • MetrePerSecond
  • MicroSecond
  • MilliCores
  • MilliSecond
  • MilliSecondPerMinute
  • Million
  • Minute
  • Month
  • NanoSecond
  • NanoSecondPerMinute
  • NotApplicable
  • PerHour
  • PerMinute
  • PerSecond
  • Percent
  • Pixel
  • Promille
  • Ratio
  • Second
  • State
  • Unspecified
  • Week
  • Year

JSON модель:

{
  "evidenceType": "METRIC",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "metricId": "string",
  "valueBeforeChangePoint": 2,
  "valueAfterChangePoint": 3,
  "unit": "Count",
  "endTime": 1602600000000
}

TRANSACTIONAL

TransactionalEvidenceMetadata

Параметры:

Объект _ TransactionalEvidence

Доказательство первопричины.

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
valueBeforeChangePoint number Значение метрики до возникновения проблемы.
valueAfterChangePoint number Значение метрики после начала проблемы.
endTime integer Время окончания свидетельства, в миллисекундах UTC
unit string Единица измерения.

JSON модель:

{
  "evidenceType": "TRANSACTIONAL",
  "displayName": "string",
  "entity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "groupingEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "rootCauseRelevant": true,
  "startTime": 1602500000000,
  "valueBeforeChangePoint": 2,
  "valueAfterChangePoint": 3,
  "unit": "Count",
  "endTime": 1602600000000
}

Вариации Impactобъекта

Объект Impactявляется базой для воздействия проблемы. Фактический набор полей зависит от типа воздействия.

APPLICATION

ApplicationImpactDto

Параметры:

Объект ApplicationImpact

Анализ воздействия проблемы на другие объекты/пользователей.

Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
impactType string Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • SERVICE-> Воздействие службы
  • APPLICATION-> Влияние приложения
  • MOBILE-> Мобильный удар
  • CUSTOM_APPLICATION-> CustomApplicationImpact

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

  • APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE
  • SERVICE
impactedEntity EntityStub Краткое представление отслеживаемого объекта.
estimatedAffectedUsers integer Предполагаемое количество затронутых пользователей.

Объект EntityStub

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
entityId EntityId Краткое представление отслеживаемого объекта.
name string Имя сущности.

Не включается в ответ, если сущность с соответствующим идентификатором не найдена.

Объект EntityId

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
id string Идентификатор сущности.
type string Тип сущности.

JSON модель:

{
  "impactType": "APPLICATION",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5
}

CUSTOM_APPLICATION

CustomApplicationImpactDto

Параметры:

Объект CustomApplicationImpact

Анализ воздействия проблемы на другие объекты/пользователей.

Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
impactType string Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • SERVICE-> Воздействие службы
  • APPLICATION-> Влияние приложения
  • MOBILE-> Мобильный удар
  • CUSTOM_APPLICATION-> CustomApplicationImpact

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

  • APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE
  • SERVICE
impactedEntity EntityStub Краткое представление отслеживаемого объекта.
estimatedAffectedUsers integer Предполагаемое количество затронутых пользователей.

Объект EntityStub

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
entityId EntityId Краткое представление отслеживаемого объекта.
name string Имя сущности.

Не включается в ответ, если сущность с соответствующим идентификатором не найдена.

Объект EntityId

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
id string Идентификатор сущности.
type string Тип сущности.

JSON модель:

{
  "impactType": "CUSTOM_APPLICATION",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5
}

MOBILE

MobileImpactDto

Параметры:

Объект MobileImpact

Анализ воздействия проблемы на другие объекты/пользователей.

Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
impactType string Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • SERVICE-> Воздействие службы
  • APPLICATION-> Влияние приложения
  • MOBILE-> Мобильный удар
  • CUSTOM_APPLICATION-> CustomApplicationImpact

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

  • APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE
  • SERVICE
impactedEntity EntityStub Краткое представление отслеживаемого объекта.
estimatedAffectedUsers integer Предполагаемое количество затронутых пользователей.

Объект EntityStub

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
entityId EntityId Краткое представление отслеживаемого объекта.
name string Имя сущности.

Не включается в ответ, если сущность с соответствующим идентификатором не найдена.

Объект EntityId

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
id string Идентификатор сущности.
type string Тип сущности.

JSON модель:

{
  "impactType": "MOBILE",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5
}

SERVICE

ServiceImpactDto

Параметры:

Объект ServiceImpact

Анализ воздействия проблемы на другие объекты/пользователей.

Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
numberOfPotentiallyAffectedServiceCalls integer Количество потенциально затронутых сервисов.

JSON модель:

{
  "impactType": "SERVICE",
  "impactedEntity": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "estimatedAffectedUsers": 5,
  "numberOfPotentiallyAffectedServiceCalls": 50
}