POST закрытие проблемы: различия между версиями

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


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


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


== Параметры ==
== Параметры ==
Строка 22: Строка 19:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|идентификатор проблемы
|problemId
|нить
|string
|ID требуемой проблемы.
|ID требуемой проблемы.
|дорожка
|path
|требуется
|требуется
|-
|-
|поля
|body
|нить
|ProblemCloseRequestDtoImpl
|Список дополнительных свойств проблемы, которые вы можете добавить к ответу.
|Тело JSON запроса. Содержит заключительный комментарий к проблеме.
 
|body
Доступны следующие свойства (все остальные свойства включены всегда, и их нельзя удалить из ответа):
 
* <code>evidenceDetails</code>: Детали основной причины.
* <code>impactAnalysis</code>: анализ воздействия проблемы на другие объекты/пользователей.
* <code>recentComments</code>: Список самых последних комментариев к проблеме.
 
Чтобы добавить свойства, укажите их в виде списка, разделенного запятыми (например, <code>evidenceDetails,impactAnalysis</code>).
|запрос
|по желанию
|по желанию
|}
|}


== Ответ ==
=== Объекты тела запроса ===
Некоторые модели JSON различаются в зависимости от типа модели. Чтобы найти все возможные варианты, обратитесь к моделям JSON .
 
=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Проблема
|Успех
|}
 
=== Объекты тела ответа ===


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


Элемент может содержать эти значения
=== JSON-модель тела запроса ===
|-
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
|управлениеЗоны
<code>{
|Зона управления []
  "message": "string"
|Список всех зон управления, к которым относится проблема.
}</code>
|-
|Уровень опасности
|нить
|Серьезность проблемы.


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


Элемент может содержать эти значения
=== Коды ответов ===
|-
|время начала
|целое число
|Отметка времени начала проблемы в миллисекундах UTC.
|-
|время окончания
|целое число
|Отметка времени окончания проблемы в миллисекундах UTC.
 
Имеет <code>-1</code>значение, если проблема все еще остается открытой.
|-
|заглавие
|нить
|Название проблемы, отображаемое в пользовательском интерфейсе.
|}
 
==== Объект _ <code>EntityStub</code> ====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Код
!Тип
|Тип
!Описание
!Описание
|-
|-
|идентификатор сущности
|200
|Идентификатор объекта
|ProblemCloseResult
|Краткое представление отслеживаемого объекта.
|Успех
|-
|-
|имя
|204
|нить
|
|Имя сущности.
|Проблема уже закрыта, запрос не выполнен.
 
Не включается в ответ, если сущность с соответствующим идентификатором не найдена.
|}
|}


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


==== Объект _ <code>LinkedProblem</code> ====
==== Объект <code>ProblemCloseResult</code> ====
Свойства связанной задачи.
Результат закрытия проблемы.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 191: Строка 82:
!Описание
!Описание
|-
|-
|displayId
|closeTimestamp
|нить
|integer
|Идентификатор отображения проблемы.
|Отметка времени, когда пользователь инициировал закрытие.
|-
|-
|идентификатор проблемы
|problemId
|нить
|string
|Идентификатор проблемы.
|Идентификатор проблемы.
|}
==== Объект _ <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
|closing
|Заглушка сущности
|boolean
|Краткое представление отслеживаемого объекта.
|Правда, если проблема закрывается.
|-
|-
|rootCauseRelevant
|comment
|логический
|Comment
|Свидетельство является ( <code>true</code>) или не является ( <code>false</code>) частью первопричины.
|Комментарий к проблеме.
|-
|время начала
|целое число
|Время начала доказательства в миллисекундах UTC.
|}
|}


==== Объект _ <code>CommentsList</code> ====
==== Объект <code>Comment</code> ====
Список комментариев.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|Комментарии
|Комментарий []
|Записи результатов.
|-
|размер страницы
|целое число
|Количество записей на странице.
|-
|ключ следующей страницы
|нить
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
 
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|общее количество
|целое число
|Общее количество записей в результате.
|}
 
==== Объект _ <code>Comment</code> ====
Комментарий к проблеме.
Комментарий к проблеме.
{| class="wikitable"
{| class="wikitable"
Строка 307: Строка 106:
!Описание
!Описание
|-
|-
|имя автора
|authorName
|нить
|string
|Пользователь, написавший комментарий.
|Пользователь, написавший комментарий.
|-
|-
|createdAtTimestamp
|createdAtTimestamp
|целое число
|integer
|Отметка времени создания комментария в миллисекундах UTC.
|Отметка времени создания комментария в миллисекундах UTC.
|-
|-
|контекст
|context
|нить
|string
|Контекст комментария.
|Контекст комментария.
|-
|-
|я бы
|id
|нить
|string
|Идентификатор комментария.
|Идентификатор комментария.
|-
|-
|содержание
|content
|нить
|string
|Текст комментария.
|Текст комментария.
|}
==== Объект _ <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-модель тела ответа ===
=== JSON-модель тела ответа ===
  <code>{
  <code>{
   "affectedEntities": [
   "closeTimestamp": 1,
    {
      "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",
   "problemId": "string",
   "status": "CLOSED",
   "closing": true,
  "startTime": 1,
  "comment": {
  "endTime": 1,
    "authorName": "string",
  "title": "string"
    "createdAtTimestamp": 1,
    "context": "string",
    "id": "string",
    "content": "string"
  }
  }</code>
  }</code>

Текущая версия на 11:01, 17 октября 2022

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

Запрос потребляет и создает application/jsonполезную нагрузку.

POST Managed https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close
Cреда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись проблем ( problems.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
problemId string ID требуемой проблемы. path требуется
body ProblemCloseRequestDtoImpl Тело JSON запроса. Содержит заключительный комментарий к проблеме. body по желанию

Объекты тела запроса

Объект ProblemCloseRequestDtoImpl

Элемент Тип Описание Необходимость
message string Текст заключительного комментария. требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. 

{
  "message": "string"
}

Ответ

Коды ответов

Код Тип Описание
200 ProblemCloseResult Успех
204 Проблема уже закрыта, запрос не выполнен.

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

Объект ProblemCloseResult

Результат закрытия проблемы.

Элемент Тип Описание
closeTimestamp integer Отметка времени, когда пользователь инициировал закрытие.
problemId string Идентификатор проблемы.
closing boolean Правда, если проблема закрывается.
comment Comment Комментарий к проблеме.

Объект Comment

Комментарий к проблеме.

Элемент Тип Описание
authorName string Пользователь, написавший комментарий.
createdAtTimestamp integer Отметка времени создания комментария в миллисекундах UTC.
context string Контекст комментария.
id string Идентификатор комментария.
content string Текст комментария.

JSON-модель тела ответа

{
  "closeTimestamp": 1,
  "problemId": "string",
  "closing": true,
  "comment": {
    "authorName": "string",
    "createdAtTimestamp": 1,
    "context": "string",
    "id": "string",
    "content": "string"
  }
}
Источник — https://doc.expert-apm.kz/index.php?title=POST_закрытие_проблемы&oldid=1763