Просмотр кода страницы GET список*

Перечисляет проблемы (и их детали), обнаруженные Ключ-АСТРОМ за относительный период времени.

Проблема включается в ответ, если метка времени начала или окончания проблемы находится в пределах заданного периода времени.

Вы можете сузить вывод, указав критерии фильтрации — см. раздел « Параметры » .

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems</nowiki></code>
|-
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems</nowiki></code>
|}

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

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

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

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

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

Поле действительно только для текущей страницы результатов. Вы должны установить его для каждой страницы, которую вы запрашиваете.
|query
|по желанию
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса, кроме параметра необязательных полей .
|query
|по желанию
|-
|pageSize
|integer
|Количество проблем в полезной нагрузке одного ответа.

Максимально допустимый размер страницы – 500.

Если не установлено, используется 50.
|query
|по желанию
|-
|from
|string
|Начало запрошенного таймфрейма.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется относительный таймфрейм в два часа ( <code>now-2h</code>).
|query
|по желанию
|-
|to
|string
|Конец запрошенного периода времени.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется текущая метка времени.
|query
|по желанию
|-
|problemSelector
|string
|Определяет область запроса. В ответ включаются только проблемы, соответствующие заданным критериям.

Вы можете добавить один или несколько из перечисленных ниже критериев. Для каждого критерия можно указать несколько значений, разделенных запятыми, если не указано иное. Если указано несколько значений, применяется логика ИЛИ . Все значения должны быть указаны.

* Статус: <code>status("open")</code>или <code>status("closed")</code>. Вы можете указать только один статус.
* Уровень серьезности: <code>severityLevel("level-1","level-2")</code>. Найдите возможные значения в описании поля серьезности ответа.
* Уровень воздействия: <code>impactLevel("level-11","level-2")</code>Найдите возможные значения в описании поля ImpactLevel ответа.
* Объект первопричины: <code>rootCauseEntity("id-1", "id-2")</code>.
* Идентификатор зоны управления: <code>managementZoneIds("mZId-1", "mzId-2")</code>.
* Имя зоны управления: <code>managementZones("value-1","value-2")</code>.
* Затронутые объекты: <code>impactedEntities("id-1", "id-2")</code>.
* Затронутые объекты: <code>affectedEntities("id-1", "id-2")</code>.
* Тип затронутых объектов: <code>affectedEntityTypes("value-1","value-2")</code>.
* Идентификатор проблемы: <code>problemId("id-1", "id-2")</code>.
* Идентификатор профиля оповещения: <code>problemFilterIds("id-1", "id-2")</code>.
* Имя профиля оповещения (содержит без учета регистра): <code>problemFilterNames("value-1","value-2")</code>.
* Имя профиля оповещения (точное совпадение, без учета регистра): <code>problemFilterNames.equals("value-1","value-2")</code>.
* Теги объекта: <code>entityTags("[context]key:value","key:value")</code>. Теги в форматах <code>[context]key:value</code>, <code>key:value</code>и <code>value</code>обнаруживаются и анализируются автоматически. Если в теге, содержащем только значение, есть двоеточие ( <code>:</code>), вы должны экранировать двоеточие обратной косой чертой ( <code>\</code>). В противном случае тег будет проанализирован как файл <code>key:value tag</code>. Все значения тегов чувствительны к регистру.
* Показать идентификатор проблемы: <code>displayId("id-1", "id-2")</code>.
* На обслуживании: <code>underMaintenance(true|false)</code>. Показывает (true) или скрывает (false) все проблемы, возникшие в режиме обслуживания.
* Текстовый поиск: <code>text("value")</code>. Текстовый поиск по следующим полям: название проблемы, заголовки событий, displayId и идентификатор затронутых и затронутых объектов. Текстовый поиск нечувствителен к регистру, имеет частичное совпадение и основан на оценке релевантности. Поэтому <code>relevance</code>следует использовать параметр сортировки, чтобы сначала получить наиболее важные проблемы. Специальные символы <code>~</code>и <code>"</code>необходимо экранировать с помощью a <code>~</code>(например, поиск в двойных кавычках <code>text("~"")</code>). Значение поиска ограничено 30 символами.

Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). В ответ включаются только результаты, соответствующие всем критериям.
|query
|по желанию
|-
|entitySelector
|string
|Область сущности запроса. Вы должны установить один из этих критериев:

* Тип объекта:<code>type("TYPE")</code>
* Идентификатор объекта Ключ-АСТРОМ: <code>entityId("id")</code>. Вы можете указать несколько идентификаторов, разделенных запятой ( <code>entityId("id-1","id-2")</code>). Все запрошенные сущности должны быть одного типа.

Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и <code>EQUALS</code>оператор используется, если не указано иное.

* Тег: <code>tag("value")</code>. Теги в форматах <code>[context]key:value</code>, <code>key:value</code>и <code>value</code>обнаруживаются и анализируются автоматически. Любые двоеточия ( <code>:</code>), которые являются частью ключа или значения, должны быть экранированы обратной косой чертой ( <code>\</code>), в противном случае она будет интерпретироваться как разделитель между ключом и значением. Все значения тегов чувствительны к регистру.
* Идентификатор зоны управления:<code>mzId(123)</code>
* Название зоны управления:<code>mzName("value")</code>
* Имя сущности:
** <code>entityName.equals</code>: выполняет <code>EQUALS</code>запрос без учета регистра.
** <code>entityName.startsWith</code>: изменяет оператор на <code>BEGINS WITH</code>.
** <code>entityName.in</code>: позволяет указать несколько значений. Оператор <code>EQUALS</code>обращается.
** <code>caseSensitive(entityName.equals("value"))</code>: принимает любой критерий имени сущности в качестве аргументов и делает значение чувствительным к регистру.
* Состояние здоровья (HEALTHY,UNHEALTHY):<code>healthState("HEALTHY")</code>
* Отметка времени первого увиденного: <code>firstSeenTms.<operator>(now-3h)</code>. Используйте любой формат метки времени из параметров from / to . Доступны следующие операторы:
** <code>lte</code>: раньше или в указанное время
** <code>lt</code>: раньше указанного времени
** <code>gte</code>: позже или в указанное время
** <code>gt</code>: позже указанного времени
* Атрибут объекта: <code><attribute>("value1","value2")</code>и <code><attribute>.exists()</code>. Чтобы получить список доступных атрибутов, выполните запрос типа сущности GET и проверьте поле свойств ответа.
* Отношения: <code>fromRelationships.<relationshipName>()</code>и <code>toRelationships.<relationshipName>()</code>. Критерий принимает селектор объектов в качестве атрибута. Чтобы получить список доступных отношений, выполните запрос типа сущности GET и проверьте поля fromRelationships и toRelationships .
* Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .

Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-АСТРОМ.

Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.

Поддерживаемая длина строки составляет 2000 символов.

Максимальное количество объектов, которые могут быть выбраны, ограничено 10000.
|query
|по желанию
|-
|sort
|string
|Указывает набор разделенных запятыми ( <code>,</code>) полей для сортировки в списке задач.

Вы можете сортировать по следующим свойствам с префиксом знака для порядка сортировки.

* <code>status</code>: статус проблемы ( <code>+</code>сначала открытые проблемы или сначала <code>-</code>закрытые проблемы)
* <code>startTime</code>: время начала проблемы ( <code>+</code>сначала старые проблемы или сначала <code>-</code>новые проблемы)
* <code>relevance</code>: релевантность проблемы ( <code>+</code>сначала наименее релевантные проблемы или сначала <code>-</code>наиболее релевантные проблемы) — может использоваться только в сочетании с текстовым поиском .

Если префикс не установлен, <code>+</code>используется .

Вы можете указать несколько уровней сортировки. Например, <code>+status,-startTime</code>сортирует проблемы по статусу, открывая проблемы первыми. В статусе проблемы отсортированы по времени начала, сначала самые старые.
|query
|по желанию
|}

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

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

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

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

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|problems
|Problem[]
|Записи результатов.
|-
|warnings
|string []
|Список предупреждений
|}

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

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

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

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

* <code>AVAILABILITY</code>
* <code>CUSTOM_ALERT</code>
* <code>ERROR</code>
* <code>INFO</code>
* <code>MONITORING_UNAVAILABLE</code>
* <code>PERFORMANCE</code>
* <code>RESOURCE_CONTENTION</code>
|-
|entityTags
|METag[]
|Список всех тегов объектов проблемы.
|-
|problemId
|string
|Идентификатор проблемы.
|-
|status
|string
|Статус проблемы.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* <code>SERVICE</code> -> ServiceImpact
* <code>APPLICATION</code> -> ApplicationImpact
* <code>MOBILE</code> -> MobileImpact
* <code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact

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

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

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

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

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

=== JSON-модель тела ответа ===
 <code>{
   "totalCount": 1,
   "pageSize": 1,
   "nextPageKey": "AQAAABQBAAAABQ==",
   "problems": [
     {
       "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"
     }
   ],
   "warnings": [
     "string"
   ]
 }</code>