JSON-модели - История изменений

IKuznetsov в 16:18, 2 января 2025

2025-01-02T16:18:51Z

← Предыдущая версия		Версия от 16:18, 2 января 2025
Строка 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 для каждого варианта перечислены ниже.		Некоторые модели JSON для API Problems v2 различаются в зависимости от типа модели. Модели JSON для каждого варианта перечислены ниже.
Строка 25:		Строка 25:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"evidenceType": "AVAILABILITY_EVIDENCE",		"evidenceType": "AVAILABILITY_EVIDENCE",
	"displayName": "string",		"displayName": "string",
Строка 255:		Строка 255:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"evidenceType": "EVENT",		"evidenceType": "EVENT",
	"displayName": "string",		"displayName": "string",
Строка 301:		Строка 301:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"evidenceType": "MAINTENANCE_WINDOW",		"evidenceType": "MAINTENANCE_WINDOW",
	"displayName": "string",		"displayName": "string",
Строка 425:		Строка 425:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"evidenceType": "METRIC",		"evidenceType": "METRIC",
	"displayName": "string",		"displayName": "string",
Строка 482:		Строка 482:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"evidenceType": "TRANSACTIONAL",		"evidenceType": "TRANSACTIONAL",
	"displayName": "string",		"displayName": "string",
Строка 583:		Строка 583:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"impactType": "APPLICATION",		"impactType": "APPLICATION",
	"impactedEntity": {		"impactedEntity": {
Строка 668:		Строка 668:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"impactType": "CUSTOM_APPLICATION",		"impactType": "CUSTOM_APPLICATION",
	"impactedEntity": {		"impactedEntity": {
Строка 753:		Строка 753:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"impactType": "MOBILE",		"impactType": "MOBILE",
	"impactedEntity": {		"impactedEntity": {
Строка 784:		Строка 784:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"impactType": "SERVICE",		"impactType": "SERVICE",
	"impactedEntity": {		"impactedEntity": {

ENetrebin в 17:43, 5 сентября 2024

2024-09-05T17:43:57Z

← Предыдущая версия		Версия от 17:43, 5 сентября 2024
Строка 1:		Строка 1:
			'''''[[Применение Ключ-АСТРОМ]] / [[Применение Ключ-АСТРОМ#.D0.92.D0.BB.D0.B0.D0.B4.D0.B5.D0.BD.D0.B8.D0.B5\|Владение]] / С[[Создание и управление владениями\|оздание и управление владениями]] / JSON-модели'''''

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

ENetrebin в 07:40, 17 октября 2022

2022-10-17T07:40:26Z

Внесённые изменения

ENetrebin: /* ДОСТУПНОСТЬ_EVIDENCE */

2022-10-17T07:15:42Z

ДОСТУПНОСТЬ_EVIDENCE

Внесённые изменения

ENetrebin: Новая страница: «Некоторые модели JSON для API Problems v2 различаются в зависимости от типа модели. Модели JSON для...»

2022-10-14T16:06:33Z

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

Новая страница

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

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

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

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

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

=== МЕРОПРИЯТИЕ ===
EventEvidenceMetadata

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

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

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

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

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

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

* <code>false</code>: Оповещение работает как обычно.
* <code>true</code>: Оповещение отключено.
|-
|на техобслуживании
|логический
|Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании.
|-
|управлениеЗоны
|Зона управления []
|Список всех зон управления, которым принадлежит событие.
|-
|идентификатор сущности
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|идентификатор события
|нить
|Идентификатор события.
|-
|сущностьТеги
|М Е тег []
|Список тегов связанного объекта.
|-
|тип события
|нить
|Тип события.
|-
|характеристики
|Свойство события []
|Список свойств события.
|-
|статус
|нить
|Статус события.

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

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

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

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

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

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

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

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

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

==== Объект _ <code>EventProperty</code> ====
Свойство события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|ценность
|нить
|Значение свойства события.
|-
|ключ
|нить
|Ключ свойства события.
|}

=== MAINTENANCE_WINDOW ===
Метаданные MaintenanceWindowEvidence

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

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|техническое обслуживаниеWindowConfigId
|нить
|Идентификатор соответствующего периода обслуживания.
|-
|время окончания
|целое число
|Время окончания свидетельства в миллисекундах UTC.
|}

=== МЕТРИЧЕСКАЯ ===
MetricEvidenceMetadata

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

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

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

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

* <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>
|}

=== ТРАНЗАКЦИОННЫЙ ===
TransactionalEvidenceMetadata

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

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|значениеBeforeChangePoint
|количество
|Значение метрики до возникновения проблемы.
|-
|значениеАфтерчанжепоинт
|количество
|Значение метрики после начала проблемы.
|-
|время окончания
|целое число
|Время окончания свидетельства, в миллисекундах UTC
|-
|Ед. изм
|нить
|Единица измерения.
|}

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

=== ЗАЯВЛЕНИЕ ===
ApplicationImpactDto

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

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

* <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>
|-
|воздействующий объект
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|предполагаемые затронутые пользователи
|целое число
|Предполагаемое количество затронутых пользователей.
|}

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

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

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

=== CUSTOM_APPLICATION ===
CustomApplicationImpactDto

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

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

* <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>
|-
|воздействующий объект
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|предполагаемые затронутые пользователи
|целое число
|Предполагаемое количество затронутых пользователей.
|}

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

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

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

=== МОБИЛЬНЫЙ ===
MobileImpactDto

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

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

* <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>
|-
|воздействующий объект
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|предполагаемые затронутые пользователи
|целое число
|Предполагаемое количество затронутых пользователей.
|}

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

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

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

=== ОКАЗАНИЕ УСЛУГ ===
ServiceImpactDto

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

Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|numberOfPotentiallyAffectedServiceCalls
|целое число
|Количество потенциально затронутых сервисов.
|}