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

2025-01-02T16:23:04Z

← Предыдущая версия		Версия от 16:23, 2 января 2025
Строка 1:		Строка 1:
			'''''[[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] / [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%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9-,%D0%9F%D1%80%D0%BE%D0%B1%D0%BB%D0%B5%D0%BC%D1%8B,-GET%20%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA Проблемы] / POST закрытие проблемы'''''

	Закрывает указанную проблему и добавляет закрывающий комментарий.		Закрывает указанную проблему и добавляет закрывающий комментарий.

Строка 54:		Строка 56:
	<{		<{
	"message": "string"		"message": "string"
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 139:		Строка 141:
	"content": "string"		"content": "string"
	}		}
	}~~</code>~~		}

IKuznetsov в 20:47, 25 декабря 2024

2024-12-25T20:47:21Z

← Предыдущая версия		Версия от 20:47, 25 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close</nowiki></code>
	\|-		\|-
Строка 52:		Строка 52:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"message": "string"		"message": "string"
	}</code>		}</code>
Строка 128:		Строка 128:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"closeTimestamp": 1,		"closeTimestamp": 1,
	"problemId": "string",		"problemId": "string",

ENetrebin в 11:01, 17 октября 2022

2022-10-17T11:01:10Z

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

ENetrebin: Новая страница: «Перечисляет все детали указанной проблемы. Запрос создает `application/json`полезную наг...»

2022-10-14T16:21:46Z

Новая страница: «Перечисляет все детали указанной проблемы. Запрос создает <code>application/json</code>полезную наг...»

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

Перечисляет все детали указанной проблемы.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения проблем ( <code>problems.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|идентификатор проблемы
|нить
|ID требуемой проблемы.
|дорожка
|требуется
|-
|поля
|нить
|Список дополнительных свойств проблемы, которые вы можете добавить к ответу.

Доступны следующие свойства (все остальные свойства включены всегда, и их нельзя удалить из ответа):

* <code>evidenceDetails</code>: Детали основной причины.
* <code>impactAnalysis</code>: анализ воздействия проблемы на другие объекты/пользователей.
* <code>recentComments</code>: Список самых последних комментариев к проблеме.

Чтобы добавить свойства, укажите их в виде списка, разделенного запятыми (например, <code>evidenceDetails,impactAnalysis</code>).
|запрос
|по желанию
|}

== Ответ ==
Некоторые модели JSON различаются в зависимости от типа модели. Чтобы найти все возможные варианты, обратитесь к моделям JSON .

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Проблема
|Успех
|}

=== Объекты тела ответа ===

==== Объект _ <code>Problem</code> ====
Свойства проблемы.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|затронутые объекты
|Заглушка объекта []
|Список всех объектов, затронутых проблемой.
|-
|rootCauseEntity
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|затронутые объекты
|Заглушка объекта []
|Список всех объектов, затронутых проблемой.
|-
|связанная информация о проблеме
|Связанная проблема
|Свойства связанной задачи.
|-
|проблемаФильтры
|Предупреждающая заготовка профиля [ ]
|Список профилей предупреждений, соответствующих проблеме.
|-
|доказательстваДетали
|Сведения о доказательствах
|Доказательства подробности проблемы.
|-
|недавние комментарии
|Список комментариев
|Список комментариев.
|-
|влияниеАнализ
|Анализ воздействия
|Список всех последствий проблемы.
|-
|displayId
|нить
|Идентификатор отображения проблемы.
|-
|уровень воздействия
|нить
|Уровень воздействия проблемы. Он показывает, на что влияет проблема.

Элемент может содержать эти значения
|-
|управлениеЗоны
|Зона управления []
|Список всех зон управления, к которым относится проблема.
|-
|Уровень опасности
|нить
|Серьезность проблемы.

Элемент может содержать эти значения
|-
|сущностьТеги
|М Е тег []
|Список всех тегов сущностей проблемы.
|-
|идентификатор проблемы
|нить
|Идентификатор проблемы.
|-
|статус
|нить
|Статус проблемы.

Элемент может содержать эти значения
|-
|время начала
|целое число
|Отметка времени начала проблемы в миллисекундах UTC.
|-
|время окончания
|целое число
|Отметка времени окончания проблемы в миллисекундах UTC.

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

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

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

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

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

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

==== Объект _ <code>EvidenceDetails</code> ====
Доказательства подробности проблемы.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|общее количество
|целое число
|Общее количество признаков проблемы.
|-
|Детали
|Доказательства []
|Список всех доказательств.
|}

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

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

* <code>EVENT</code>-> EventEvidence
* <code>METRIC</code>-> МетрикаДоказательство
* <code>TRANSACTIONAL</code>-> Транзакционные доказательства
* <code>MAINTENANCE_WINDOW</code>-> MaintenanceWindowEvidence
* <code>AVAILABILITY_EVIDENCE</code>-> Наличие доказательств

Элемент может содержать эти значения
|-
|показать имя
|нить
|Отображаемое имя свидетельства.
|-
|организация
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|группировкаEntity
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|rootCauseRelevant
|логический
|Свидетельство является ( <code>true</code>) или не является ( <code>false</code>) частью первопричины.
|-
|время начала
|целое число
|Время начала доказательства в миллисекундах UTC.
|}

==== Объект _ <code>CommentsList</code> ====
Список комментариев.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|Комментарии
|Комментарий []
|Записи результатов.
|-
|размер страницы
|целое число
|Количество записей на странице.
|-
|ключ следующей страницы
|нить
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|общее количество
|целое число
|Общее количество записей в результате.
|}

==== Объект _ <code>Comment</code> ====
Комментарий к проблеме.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|имя автора
|нить
|Пользователь, написавший комментарий.
|-
|createdAtTimestamp
|целое число
|Отметка времени создания комментария в миллисекундах UTC.
|-
|контекст
|нить
|Контекст комментария.
|-
|я бы
|нить
|Идентификатор комментария.
|-
|содержание
|нить
|Текст комментария.
|}

==== Объект _ <code>ImpactAnalysis</code> ====
Список всех последствий проблемы.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|удары
|Влияние []
|Список всех последствий проблемы.
|}

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

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

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

Элемент может содержать эти значения
|-
|воздействующий объект
|Заглушка сущности
|Краткое представление отслеживаемого объекта.
|-
|предполагаемые затронутые пользователи
|целое число
|Предполагаемое количество затронутых пользователей.
|}

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

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

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

=== JSON-модель тела ответа ===
<code>{
"affectedEntities": [
{
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
}
],
"rootCauseEntity": {},
"impactedEntities": [
{}
],
"linkedProblemInfo": {
"displayId": "string",
"problemId": "string"
},
"problemFilters": [
{
"name": "string",
"id": "string"
}
],
"evidenceDetails": {
"totalCount": 1,
"details": [
{
"evidenceType": "AVAILABILITY_EVIDENCE",
"displayName": "string",
"entity": {},
"groupingEntity": {},
"rootCauseRelevant": true,
"startTime": 1
}
]
},
"recentComments": {
"comments": [
{
"authorName": "string",
"createdAtTimestamp": 1,
"context": "string",
"id": "string",
"content": "string"
}
],
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1
},
"impactAnalysis": {
"impacts": [
{
"impactType": "APPLICATION",
"impactedEntity": {},
"estimatedAffectedUsers": 1
}
]
},
"displayId": "string",
"impactLevel": "APPLICATION",
"managementZones": [
{
"name": "string",
"id": "string"
}
],
"severityLevel": "AVAILABILITY",
"entityTags": [
{
"stringRepresentation": "string",
"value": "string",
"key": "string",
"context": "string"
}
],
"problemId": "string",
"status": "CLOSED",
"startTime": 1,
"endTime": 1,
"title": "string"
}</code>

POST закрытие проблемы - История изменений

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

IKuznetsov в 20:47, 25 декабря 2024

ENetrebin в 11:01, 17 октября 2022

ENetrebin: Новая страница: «Перечисляет все детали указанной проблемы. Запрос создает application/jsonполезную наг...»

ENetrebin: Новая страница: «Перечисляет все детали указанной проблемы. Запрос создает `application/json`полезную наг...»