JSON-модели

Применение Ключ-АСТРОМ / Владение / Создание и управление владениями / JSON-модели

Некоторые модели 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
}