GET детали

Материал из Документация Ключ-АСТРОМ
Версия от 10:50, 17 октября 2022; ENetrebin (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)


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

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

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

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

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

Параметры

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

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

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

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

query по желанию

Ответ

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

Коды ответов

Код Тип Описание
200 Problem Успех

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

Объект Problem

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

Элемент Элемент Описание
affectedEntities EntityStub[] Список всех объектов, затронутых проблемой.
rootCauseEntity EntityStub Краткое представление отслеживаемого объекта.
impactedEntities EntityStub[] Список всех объектов, затронутых проблемой.
linkedProblemInfo LinkedProblem Свойства связанной задачи.
problemFilters AlertingProfileStub[] Список профилей предупреждений, соответствующих проблеме.
evidenceDetails EvidenceDetails Доказательства подробности проблемы.
recentComments CommentsList Список комментариев.
impactAnalysis ImpactAnalysis Список всех последствий проблемы.
displayId string Идентификатор отображения проблемы.
impactLevel string Уровень воздействия проблемы. Он показывает, на что влияет проблема.

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

  • APPLICATION
  • ENVIRONMENT
  • INFRASTRUCTURE
  • SERVICES
managementZones ManagementZone[] Список всех зон управления, к которым относится проблема.
severityLevel string Серьезность проблемы.

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

  • AVAILABILITY
  • CUSTOM_ALERT
  • ERROR
  • INFO
  • MONITORING_UNAVAILABLE
  • PERFORMANCE
  • RESOURCE_CONTENTION
entityTags METag[] Список всех тегов сущностей проблемы.
problemId string Идентификатор проблемы.
status string Статус проблемы.

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

  • CLOSED
  • OPEN
startTime integer Отметка времени начала проблемы в миллисекундах UTC.
endTime integer Отметка времени окончания проблемы в миллисекундах UTC.

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

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

Объект EntityStub

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

Элемент Тип Описание
entityId EntityId Краткое представление отслеживаемого объекта.
имя string Имя объекта.

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

Объект EntityId

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

Элемент Тип Описание
id string Идентификатор объекта.
type string Тип объекта.

Объект LinkedProblem

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

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

Объект AlertingProfileStub

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

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

Объект EvidenceDetails

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

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

Объект Evidence

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

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

Элемент Тип Описание
evidenceType string Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • EVENT -> EventEvidence
  • METRIC -> MetricEvidence
  • TRANSACTIONAL -> TransactionalEvidence
  • MAINTENANCE_WINDOW -> MaintenanceWindowEvidence
  • AVAILABILITY_EVIDENCE -> AvailabilityEvidence

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

  • AVAILABILITY_EVIDENCE
  • EVENT
  • MAINTENANCE_WINDOW
  • METRIC
  • TRANSACTIONAL
displayName string Отображаемое имя свидетельства.
entity EntityStub Краткое представление отслеживаемого объекта.
groupingEntity EntityStub Краткое представление отслеживаемого объекта.
rootCauseRelevant boolean Свидетельство является ( true) или не является ( false) частью первопричины.
startTime integer Время начала доказательства в миллисекундах UTC.

Объект CommentsList

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

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

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

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

Объект Comment

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

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

Объект ImpactAnalysis

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

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

Объект Impact

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

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

Элемент Тип Описание
impactType string Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • SERVICE -> ServiceImpact
  • APPLICATION -> ApplicationImpact
  • MOBILE -> MobileImpact
  • CUSTOM_APPLICATION -> CustomApplicationImpact

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

  • APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE
  • SERVICE
impactedEntity EntityStub Краткое представление отслеживаемого объекта.
estimatedAffectedUsers integer Предполагаемое количество затронутых пользователей.

Объект ManagementZone

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

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

Объект METag

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

Элемент Тип Описание
stringRepresentation string Строковое представление тега.
value string Значение тега.
key string Ключ тега.
context string Происхождение тега, например 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=GET_детали&oldid=1762