Просмотр кода страницы JSON-модели

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

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

=== AVAILABILITY_EVIDENCE ===
<u>AvailabilityEvidenceMetadata</u>

'''Параметры:'''

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

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|endTime
|integer
|Время окончания свидетельства в миллисекундах 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>

'''Параметры:'''

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

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

Имеет <code>-1</code>значение, если событие все еще активно.
|}

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

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

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

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

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

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

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

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

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

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

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

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

Пользовательские теги используют это <code>CONTEXTLESS</code>значение.
|}

==== Объект <code>EventProperty</code> ====
Свойство события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|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 ===
<u>Метаданные MaintenanceWindowEvidence</u>

'''Параметры:'''

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

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|maintenanceWindowConfigId
|string
|Идентификатор соответствующего периода обслуживания.
|-
|endTime
|integer
|Время окончания свидетельства в миллисекундах 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>

'''Параметры:'''

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

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

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

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

* <code>Billion</code>
* <code>Bit</code>
* <code>BitPerHour</code>
* <code>BitPerMinute</code>
* <code>BitPerSecond</code>
* <code>Byte</code>
* <code>BytePerHour</code>
* <code>BytePerMinute</code>
* <code>BytePerSecond</code>
* <code>Cores</code>
* <code>Count</code>
* <code>Day</code>
* <code>DecibelMilliWatt</code>
* <code>GibiByte</code>
* <code>Giga</code>
* <code>GigaByte</code>
* <code>Hour</code>
* <code>KibiByte</code>
* <code>KibiBytePerHour</code>
* <code>KibiBytePerMinute</code>
* <code>KibiBytePerSecond</code>
* <code>Kilo</code>
* <code>KiloByte</code>
* <code>KiloBytePerHour</code>
* <code>KiloBytePerMinute</code>
* <code>KiloBytePerSecond</code>
* <code>KiloMetrePerHour</code>
* <code>MSU</code>
* <code>MebiByte</code>
* <code>MebiBytePerHour</code>
* <code>MebiBytePerMinute</code>
* <code>MebiBytePerSecond</code>
* <code>Mega</code>
* <code>MegaByte</code>
* <code>MegaBytePerHour</code>
* <code>MegaBytePerMinute</code>
* <code>MegaBytePerSecond</code>
* <code>MetrePerHour</code>
* <code>MetrePerSecond</code>
* <code>MicroSecond</code>
* <code>MilliCores</code>
* <code>MilliSecond</code>
* <code>MilliSecondPerMinute</code>
* <code>Million</code>
* <code>Minute</code>
* <code>Month</code>
* <code>NanoSecond</code>
* <code>NanoSecondPerMinute</code>
* <code>NotApplicable</code>
* <code>PerHour</code>
* <code>PerMinute</code>
* <code>PerSecond</code>
* <code>Percent</code>
* <code>Pixel</code>
* <code>Promille</code>
* <code>Ratio</code>
* <code>Second</code>
* <code>State</code>
* <code>Unspecified</code>
* <code>Week</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 ===
<u>TransactionalEvidenceMetadata</u>

'''Параметры:'''

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

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|valueBeforeChangePoint
|number
|Значение метрики до возникновения проблемы.
|-
|valueAfterChangePoint
|number
|Значение метрики после начала проблемы.
|-
|endTime
|integer
|Время окончания свидетельства, в миллисекундах 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>является базой для воздействия проблемы. Фактический набор полей зависит от типа воздействия.

=== APPLICATION ===
<u>ApplicationImpactDto</u>

'''Параметры:'''

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

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

* <code>SERVICE</code>-> Воздействие службы
* <code>APPLICATION</code>-> Влияние приложения
* <code>MOBILE</code>-> Мобильный удар
* <code>CUSTOM_APPLICATION</code>-> CustomApplicationImpact

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

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

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

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

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

=== CUSTOM_APPLICATION ===
<u>CustomApplicationImpactDto</u>

'''Параметры:'''

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

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

* <code>SERVICE</code>-> Воздействие службы
* <code>APPLICATION</code>-> Влияние приложения
* <code>MOBILE</code>-> Мобильный удар
* <code>CUSTOM_APPLICATION</code>-> CustomApplicationImpact

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

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

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

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

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

=== MOBILE ===
<u>MobileImpactDto</u>

'''Параметры:'''

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

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

* <code>SERVICE</code>-> Воздействие службы
* <code>APPLICATION</code>-> Влияние приложения
* <code>MOBILE</code>-> Мобильный удар
* <code>CUSTOM_APPLICATION</code>-> CustomApplicationImpact

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

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

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

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

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

=== SERVICE ===
<u>ServiceImpactDto</u>

'''Параметры:'''

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

Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|numberOfPotentiallyAffectedServiceCalls
|integer
|Количество потенциально затронутых сервисов.
|}
'''JSON модель:'''
 <code>{
   "impactType": "SERVICE",
   "impactedEntity": {
     "entityId": {
       "id": "string",
       "type": "string"
     },
     "name": "string"
   },
   "estimatedAffectedUsers": 5,
   "numberOfPotentiallyAffectedServiceCalls": 50
 }</code>