JSON-модели: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Некоторые модели JSON для API Problems v2 различаются в зависимости от типа модели. Модели JSON для...») |
ENetrebin (обсуждение | вклад) |
||
Строка 4: | Строка 4: | ||
Объект <code>Evidence</code>является основой для доказательства проблемы. Фактический набор полей зависит от типа свидетельства. | Объект <code>Evidence</code>является основой для доказательства проблемы. Фактический набор полей зависит от типа свидетельства. | ||
=== | === AVAILABILITY_EVIDENCE === | ||
AvailabilityEvidenceMetadata | |||
==== Объект | '''Параметры:''' | ||
==== Объект <code>AvailabilityEvidence</code> ==== | |||
Доказательство первопричины. | Доказательство первопричины. | ||
Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании | Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля 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 === | ||
EventEvidenceMetadata | EventEvidenceMetadata | ||
==== Объект | '''Параметры:''' | ||
==== Объект <code>EventEvidence</code> ==== | |||
Доказательство первопричины. | Доказательство первопричины. | ||
Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании | Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поля videType или посмотрите модели Problems API v2-JSON . | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 33: | Строка 59: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |eventId | ||
| | |string | ||
|Идентификатор события. | |Идентификатор события. | ||
|- | |- | ||
| | |data | ||
| | |Event | ||
|Конфигурация события. | |Конфигурация события. | ||
|- | |- | ||
| | |eventType | ||
| | |string | ||
|Тип события. | |Тип события. | ||
|- | |- | ||
| | |endTime | ||
| | |integer | ||
|Отметка времени окончания события в миллисекундах UTC. | |Отметка времени окончания события в миллисекундах UTC. | ||
Строка 226: | Строка 252: | ||
|Ключ свойства события. | |Ключ свойства события. | ||
|} | |} | ||
'''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 | |||
==== Метаданные MaintenanceWindowEvidence ==== | |||
'''Параметры:''' | |||
==== Объект _ <code>MaintenanceWindowEvidence</code> ==== | ==== Объект _ <code>MaintenanceWindowEvidence</code> ==== | ||
Строка 247: | Строка 298: | ||
|Время окончания свидетельства в миллисекундах 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 === | ||
MetricEvidenceMetadata | |||
==== MetricEvidenceMetadata ==== | |||
'''Параметры:''' | |||
==== Объект _ <code>MetricEvidence</code> ==== | ==== Объект _ <code>MetricEvidence</code> ==== | ||
Строка 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 | |||
=== TransactionalEvidenceMetadata === | |||
'''Параметры:''' | |||
==== Объект _ <code>TransactionalEvidence</code> ==== | ==== Объект _ <code>TransactionalEvidence</code> ==== | ||
Строка 375: | Строка 479: | ||
|Единица измерения. | |Единица измерения. | ||
|} | |} | ||
'''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>объекта == | ||
Строка 380: | Строка 509: | ||
=== ЗАЯВЛЕНИЕ === | === ЗАЯВЛЕНИЕ === | ||
ApplicationImpactDto | <u>ApplicationImpactDto</u> | ||
'''Параметры:''' | |||
==== Объект _ <code>ApplicationImpact</code> ==== | ==== Объект _ <code>ApplicationImpact</code> ==== | ||
Строка 449: | Строка 580: | ||
|Тип сущности. | |Тип сущности. | ||
|} | |} | ||
'''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> ==== | ||
Строка 520: | Строка 665: | ||
|Тип сущности. | |Тип сущности. | ||
|} | |} | ||
'''JSON модель:''' | |||
<code>{ | |||
"impactType": "CUSTOM_APPLICATION", | |||
"impactedEntity": { | |||
"entityId": { | |||
"id": "string", | |||
"type": "string" | |||
}, | |||
"name": "string" | |||
}, | |||
"estimatedAffectedUsers": 5 | |||
}</code> | |||
=== MOBILE === | |||
<u>MobileImpactDto</u> | |||
'''Параметры:''' | |||
==== Объект _ <code>MobileImpact</code> ==== | ==== Объект _ <code>MobileImpact</code> ==== | ||
Строка 591: | Строка 750: | ||
|Тип сущности. | |Тип сущности. | ||
|} | |} | ||
'''JSON модель:''' | |||
<code>{ | |||
"impactType": "MOBILE", | |||
"impactedEntity": { | |||
"entityId": { | |||
"id": "string", | |||
"type": "string" | |||
}, | |||
"name": "string" | |||
}, | |||
"estimatedAffectedUsers": 5 | |||
}</code> | |||
=== SERVICE === | |||
<u>ServiceImpactDto</u> | |||
'''Параметры:''' | |||
==== Объект | ==== Объект <code>ServiceImpact</code> ==== | ||
Анализ воздействия проблемы на другие объекты/пользователей. | Анализ воздействия проблемы на другие объекты/пользователей. | ||
Строка 608: | Строка 781: | ||
|Количество потенциально затронутых сервисов. | |Количество потенциально затронутых сервисов. | ||
|} | |} | ||
'''JSON модель:''' | |||
<code>{ | |||
"impactType": "SERVICE", | |||
"impactedEntity": { | |||
"entityId": { | |||
"id": "string", | |||
"type": "string" | |||
}, | |||
"name": "string" | |||
}, | |||
"estimatedAffectedUsers": 5, | |||
"numberOfPotentiallyAffectedServiceCalls": 50 | |||
}</code> |
Версия 07:15, 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.
Имеет |
Объект _ Event
Конфигурация события.
Элемент | Тип | Описание |
---|---|---|
частособытие | логический | Если true , событие происходит часто .
Частое событие не вызывает проблем. |
подавлятьпроблему | логический | Статус обнаружения проблемы во время технического обслуживания :
|
подавлять оповещение | логический | Состояние предупреждения во время технического обслуживания :
|
на техобслуживании | логический | Если true , событие произошло, когда отслеживаемая система находилась на обслуживании.
|
управлениеЗоны | Зона управления [] | Список всех зон управления, которым принадлежит событие. |
идентификатор сущности | Заглушка сущности | Краткое представление отслеживаемого объекта. |
идентификатор события | нить | Идентификатор события. |
сущностьТеги | М Е тег [] | Список тегов связанного объекта. |
тип события | нить | Тип события. |
характеристики | Свойство события [] | Список свойств события. |
статус | нить | Статус события.
Элемент может содержать эти значения
|
время начала | целое число | Отметка времени возникновения события в миллисекундах UTC. |
время окончания | целое число | Отметка времени закрытия события в миллисекундах UTC.
Имеет значение, |
заглавие | нить | Название события. |
идентификатор корреляции | нить | Идентификатор корреляции события. |
Объект _ ManagementZone
Краткое представление зоны управления.
Элемент | Тип | Описание |
---|---|---|
имя | нить | Имя зоны управления. |
я бы | нить | Идентификатор зоны управления. |
Объект _ EntityStub
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
идентификатор сущности | Идентификатор объекта | Краткое представление отслеживаемого объекта. |
имя | нить | Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. |
Объект _ EntityId
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
я бы | нить | Идентификатор сущности. |
тип | нить | Тип сущности. |
Объект _ METag
Тег отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
представление строки | нить | Строковое представление тега. |
ценность | нить | Значение тега. |
ключ | нить | Ключ тега. |
контекст | нить | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это |
Объект _ EventProperty
Свойство события.
Элемент | Тип | Описание |
---|---|---|
ценность | нить | Значение свойства события. |
ключ | нить | Ключ свойства события. |
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 .
Элемент | Тип | Описание |
---|---|---|
техническое обслуживаниеWindowConfigId | нить | Идентификатор соответствующего периода обслуживания. |
время окончания | целое число | Время окончания свидетельства в миллисекундах 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 .
Элемент | Тип | Описание |
---|---|---|
значениеBeforeChangePoint | количество | Значение метрики до возникновения проблемы. |
значениеАфтерчанжепоинт | количество | Значение метрики после начала проблемы. |
идентификатор метрики | нить | Идентификатор метрики. |
время окончания | целое число | Время окончания свидетельства в миллисекундах UTC.
Значение |
Ед. изм | нить | Единица измерения.
Элемент может содержать эти значения
|
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 .
Элемент | Тип | Описание |
---|---|---|
значениеBeforeChangePoint | количество | Значение метрики до возникновения проблемы. |
значениеАфтерчанжепоинт | количество | Значение метрики после начала проблемы. |
время окончания | целое число | Время окончания свидетельства, в миллисекундах UTC |
Ед. изм | нить | Единица измерения. |
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
является базой для воздействия проблемы. Фактический набор полей зависит от типа воздействия.
ЗАЯВЛЕНИЕ
ApplicationImpactDto
Параметры:
Объект _ ApplicationImpact
Анализ воздействия проблемы на другие объекты/пользователей.
Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .
Элемент | Тип | Описание |
---|---|---|
ударТип | нить | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
воздействующий объект | Заглушка сущности | Краткое представление отслеживаемого объекта. |
предполагаемые затронутые пользователи | целое число | Предполагаемое количество затронутых пользователей. |
Объект _ EntityStub
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
идентификатор сущности | Идентификатор объекта | Краткое представление отслеживаемого объекта. |
имя | нить | Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. |
Объект _ EntityId
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
я бы | нить | Идентификатор сущности. |
тип | нить | Тип сущности. |
JSON модель:
{
"impactType": "APPLICATION",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5
}
CUSTOM_APPLICATION
CustomApplicationImpactDto
Параметры:
Объект _ CustomApplicationImpact
Анализ воздействия проблемы на другие объекты/пользователей.
Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .
Элемент | Тип | Описание |
---|---|---|
ударТип | нить | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
воздействующий объект | Заглушка сущности | Краткое представление отслеживаемого объекта. |
предполагаемые затронутые пользователи | целое число | Предполагаемое количество затронутых пользователей. |
Объект _ EntityStub
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
идентификатор сущности | Идентификатор объекта | Краткое представление отслеживаемого объекта. |
имя | нить | Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. |
Объект _ EntityId
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
я бы | нить | Идентификатор сущности. |
тип | нить | Тип сущности. |
JSON модель:
{
"impactType": "CUSTOM_APPLICATION",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5
}
MOBILE
MobileImpactDto
Параметры:
Объект _ MobileImpact
Анализ воздействия проблемы на другие объекты/пользователей.
Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .
Элемент | Тип | Описание |
---|---|---|
ударТип | нить | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
воздействующий объект | Заглушка сущности | Краткое представление отслеживаемого объекта. |
предполагаемые затронутые пользователи | целое число | Предполагаемое количество затронутых пользователей. |
Объект _ EntityStub
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
идентификатор сущности | Идентификатор объекта | Краткое представление отслеживаемого объекта. |
имя | нить | Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. |
Объект _ EntityId
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
я бы | нить | Идентификатор сущности. |
тип | нить | Тип сущности. |
JSON модель:
{
"impactType": "MOBILE",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5
}
SERVICE
ServiceImpactDto
Параметры:
Объект ServiceImpact
Анализ воздействия проблемы на другие объекты/пользователей.
Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .
Элемент | Тип | Описание |
---|---|---|
numberOfPotentiallyAffectedServiceCalls | целое число | Количество потенциально затронутых сервисов. |
JSON модель:
{
"impactType": "SERVICE",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5,
"numberOfPotentiallyAffectedServiceCalls": 50
}