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

Текущая версия от 16:18, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Проблемы v2 / GET объект

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

@@ Строка 1: / Строка 1: @@
-'''''[[Применение Ключ-АСТРОМ]] / [[Применение Ключ-АСТРОМ#.D0.92.D0.BB.D0.B0.D0.B4.D0.B5.D0.BD.D0.B8.D0.B5|Владение]] / С[[Создание и управление владениями|оздание и управление владениями]] / JSON-модели'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A1%D0%B5%D0%BB%D0%B5%D0%BA%D1%82%D0%BE%D1%80%20%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D0%BE%D0%B2-,%D0%9F%D1%80%D0%BE%D0%B1%D0%BB%D0%B5%D0%BC%D1%8B%20v2,-JSON%2D%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8 Проблемы v2] / GET объект'''''
 Некоторые модели JSON для API Problems v2 различаются в зависимости от типа модели. Модели JSON для каждого варианта перечислены ниже.
@@ Строка 25: / Строка 25: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "evidenceType": "AVAILABILITY_EVIDENCE",
     "displayName": "string",
@@ Строка 255: / Строка 255: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "evidenceType": "EVENT",
     "displayName": "string",
@@ Строка 301: / Строка 301: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "evidenceType": "MAINTENANCE_WINDOW",
     "displayName": "string",
@@ Строка 425: / Строка 425: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "evidenceType": "METRIC",
     "displayName": "string",
@@ Строка 482: / Строка 482: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "evidenceType": "TRANSACTIONAL",
     "displayName": "string",
@@ Строка 583: / Строка 583: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "impactType": "APPLICATION",
     "impactedEntity": {
@@ Строка 668: / Строка 668: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "impactType": "CUSTOM_APPLICATION",
     "impactedEntity": {
@@ Строка 753: / Строка 753: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "impactType": "MOBILE",
     "impactedEntity": {
@@ Строка 784: / Строка 784: @@
 |}
 '''JSON модель:'''
-  <code>{
+  <{
     "impactType": "SERVICE",
     "impactedEntity": {

Текущая версия от 16:18, 2 января 2025

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

AVAILABILITY_EVIDENCE

Объект AvailabilityEvidence

EVENT

Объект EventEvidence

Объект Event

Объект ManagementZone

Объект EntityStub

Объект EntityId

Объект METag

Объект EventProperty

MAINTENANCE_WINDOW

Объект MaintenanceWindowEvidence

METRIC

ОбъектMetricEvidence

TRANSACTIONAL

Объект _ TransactionalEvidence

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

APPLICATION

Объект ApplicationImpact

Объект EntityStub

Объект EntityId

CUSTOM_APPLICATION

Объект CustomApplicationImpact

Объект EntityStub

Объект EntityId

MOBILE

Объект MobileImpact

Объект EntityStub

Объект EntityId

SERVICE

Объект ServiceImpact

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

Объект `AvailabilityEvidence`

Объект `EventEvidence`

Объект `Event`

Объект `ManagementZone`

Объект `EntityStub`

Объект `EntityId`

Объект `METag`

Объект `EventProperty`

Объект `MaintenanceWindowEvidence`

Объект`MetricEvidence`

Объект _ `TransactionalEvidence`

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

Объект `ApplicationImpact`

Объект `EntityStub`

Объект `EntityId`

Объект `CustomApplicationImpact`

Объект `EntityStub`

Объект `EntityId`

Объект `MobileImpact`

Объект `EntityStub`

Объект `EntityId`

Объект `ServiceImpact`