POST закрытие проблемы

Материал из Документация Ключ-АСТРОМ
Версия от 16:21, 14 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Перечисляет все детали указанной проблемы. Запрос создает <code>application/json</code>полезную наг...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

ПОЛУЧИТЬ Удалось https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}
SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}
Окружающая среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}

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

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

Параметры

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

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

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

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

запрос по желанию

Ответ

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

Коды ответов

Код Тип Описание
200 Проблема Успех

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

Объект _ Problem

Свойства проблемы.

Элемент Тип Описание
затронутые объекты Заглушка объекта [] Список всех объектов, затронутых проблемой.
rootCauseEntity Заглушка сущности Краткое представление отслеживаемого объекта.
затронутые объекты Заглушка объекта [] Список всех объектов, затронутых проблемой.
связанная информация о проблеме Связанная проблема Свойства связанной задачи.
проблемаФильтры Предупреждающая заготовка профиля [ ] Список профилей предупреждений, соответствующих проблеме.
доказательстваДетали Сведения о доказательствах Доказательства подробности проблемы.
недавние комментарии Список комментариев Список комментариев.
влияниеАнализ Анализ воздействия Список всех последствий проблемы.
displayId нить Идентификатор отображения проблемы.
уровень воздействия нить Уровень воздействия проблемы. Он показывает, на что влияет проблема.

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

управлениеЗоны Зона управления [] Список всех зон управления, к которым относится проблема.
Уровень опасности нить Серьезность проблемы.

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

сущностьТеги М Е тег [] Список всех тегов сущностей проблемы.
идентификатор проблемы нить Идентификатор проблемы.
статус нить Статус проблемы.

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

время начала целое число Отметка времени начала проблемы в миллисекундах UTC.
время окончания целое число Отметка времени окончания проблемы в миллисекундах UTC.

Имеет -1значение, если проблема все еще остается открытой.

заглавие нить Название проблемы, отображаемое в пользовательском интерфейсе.

Объект _ EntityStub

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
идентификатор сущности Идентификатор объекта Краткое представление отслеживаемого объекта.
имя нить Имя сущности.

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

Объект _ EntityId

Краткое представление отслеживаемого объекта.

Элемент Тип Описание
я бы нить Идентификатор сущности.
тип нить Тип сущности.

Объект _ LinkedProblem

Свойства связанной задачи.

Элемент Тип Описание
displayId нить Идентификатор отображения проблемы.
идентификатор проблемы нить Идентификатор проблемы.

Объект _ AlertingProfileStub

Краткое представление профиля предупреждений.

Элемент Тип Описание
имя нить Имя профиля предупреждений.
я бы нить Идентификатор профиля оповещения.

Объект _ EvidenceDetails

Доказательства подробности проблемы.

Элемент Тип Описание
общее количество целое число Общее количество признаков проблемы.
Детали Доказательства [] Список всех доказательств.

Объект _ Evidence

Доказательство первопричины.

Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
тип доказательства нить Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • EVENT-> EventEvidence
  • METRIC-> МетрикаДоказательство
  • TRANSACTIONAL-> Транзакционные доказательства
  • MAINTENANCE_WINDOW-> MaintenanceWindowEvidence
  • AVAILABILITY_EVIDENCE-> Наличие доказательств

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

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

Объект _ CommentsList

Список комментариев.

Элемент Тип Описание
Комментарии Комментарий [] Записи результатов.
размер страницы целое число Количество записей на странице.
ключ следующей страницы нить Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

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

общее количество целое число Общее количество записей в результате.

Объект _ Comment

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

Элемент Тип Описание
имя автора нить Пользователь, написавший комментарий.
createdAtTimestamp целое число Отметка времени создания комментария в миллисекундах UTC.
контекст нить Контекст комментария.
я бы нить Идентификатор комментария.
содержание нить Текст комментария.

Объект _ ImpactAnalysis

Список всех последствий проблемы.

Элемент Тип Описание
удары Влияние [] Список всех последствий проблемы.

Объект _ Impact

Анализ воздействия проблемы на другие объекты/пользователей.

Фактический набор полей зависит от типа воздействия. Найдите список актуальных объектов в описании поля ImpactType или посмотрите модели Problems API v2-JSON .

Элемент Тип Описание
ударТип нить Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • SERVICE-> Воздействие службы
  • APPLICATION-> Влияние приложения
  • MOBILE-> Мобильный удар
  • CUSTOM_APPLICATION-> CustomApplicationImpact

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

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

Объект _ ManagementZone

Краткое представление зоны управления.

Элемент Тип Описание
имя нить Имя зоны управления.
я бы нить Идентификатор зоны управления.

Объект _ METag

Тег отслеживаемого объекта.

Элемент Тип Описание
представление строки нить Строковое представление тега.
ценность нить Значение тега.
ключ нить Ключ тега.
контекст нить Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это CONTEXTLESSзначение.

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

{
  "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"
}
Источник — https://doc.ruscomtech.ru/index.php?title=POST_закрытие_проблемы&oldid=1748