GET список*: различия между версиями
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| Строка 347: | Строка 347: | ||
|name | |name | ||
|string | |string | ||
|Имя | |Имя объекта. | ||
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. | Не включается в ответ, если сущность с соответствующим идентификатором не найдена. | ||
| Строка 428: | Строка 428: | ||
|string | |string | ||
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | |Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
Версия 09:38, 17 октября 2022
Перечисляет проблемы (и их детали), обнаруженные Ключ-АСТРОМ за относительный период времени.
Проблема включается в ответ, если метка времени начала или окончания проблемы находится в пределах заданного периода времени.
Вы можете сузить вывод, указав критерии фильтрации — см. раздел « Параметры » .
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/problems
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения проблем ( problems.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| fields | string | Список дополнительных свойств проблемы, которые вы можете добавить к ответу.
Доступны следующие свойства (все остальные свойства включены всегда, и их нельзя удалить из ответа):
Чтобы добавить свойства, укажите их в виде списка, разделенного запятыми (например, Поле действительно только для текущей страницы результатов. Вы должны установить его для каждой страницы, которую вы запрашиваете. |
query | по желанию |
| nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса, кроме параметра необязательных полей . |
query | по желанию |
| pageSize | integer | Количество проблем в полезной нагрузке одного ответа.
Максимально допустимый размер страницы – 500. Если не установлено, используется 50. |
query | по желанию |
| from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не установлено, используется относительный таймфрейм в два часа ( |
query | по желанию |
| to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
query | по желанию |
| problemSelector | string | Определяет область запроса. В ответ включаются только проблемы, соответствующие заданным критериям.
Вы можете добавить один или несколько из перечисленных ниже критериев. Для каждого критерия можно указать несколько значений, разделенных запятыми, если не указано иное. Если указано несколько значений, применяется логика ИЛИ . Все значения должны быть указаны.
Чтобы задать несколько критериев, разделите их запятой ( |
query | по желанию |
| entitySelector | string | Область сущности запроса. Вы должны установить один из этих критериев:
Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и
Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-АСТРОМ. Чтобы задать несколько критериев, разделите их запятой ( Поддерживаемая длина строки составляет 2000 символов. Максимальное количество объектов, которые могут быть выбраны, ограничено 10000. |
query | по желанию |
| sort | string | Указывает набор разделенных запятыми ( ,) полей для сортировки в списке задач.
Вы можете сортировать по следующим свойствам с префиксом знака для порядка сортировки.
Если префикс не установлен, Вы можете указать несколько уровней сортировки. Например, |
query | по желанию |
Ответ
Некоторые модели JSON различаются в зависимости от типа модели. Чтобы найти все возможные варианты, обратитесь к моделям JSON .
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Problems | Успех |
Объекты тела ответа
Объект Problems
Список проблем.
| Элемент | Тип | Описание |
|---|---|---|
| totalCount | integer | Общее количество записей в результате. |
| pageSize | integer | Количество записей на странице. |
| nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение nullна последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. |
| problems | Problem[] | Записи результатов. |
| warnings | string [] | Список предупреждений |
Объект Problem
Свойства проблемы.
| Элемент | Тип | Описание |
|---|---|---|
| affectedEntities | EntityStub[] | Список всех объектов, затронутых проблемой. |
| rootCauseEntity | EntityStub | Краткое представление отслеживаемого объекта. |
| impactedEntities | EntityStub[] | Список всех объектов, затронутых проблемой. |
| linkedProblemInfo | LinkedProblem | Свойства связанной задачи. |
| problemFilters | AlertingProfileStub[] | Список профилей предупреждений, соответствующих проблеме. |
| evidenceDetails | EvidenceDetails | Доказательства подробности проблемы. |
| recentComments | CommentsList | Список комментариев. |
| impactAnalysis | ImpactAnalysis | Список всех последствий проблемы. |
| displayId | string | Идентификатор отображения проблемы. |
| impactLevel | string | Уровень воздействия проблемы. Он показывает, на что влияет проблема.
Элемент может содержать эти значения
|
| managementZones | ManagementZone[] | Список всех зон управления, к которым относится проблема. |
| severityLevel | string | Серьезность проблемы.
Элемент может содержать эти значения
|
| entityTags | METag[] | Список всех тегов объектов проблемы. |
| problemId | string | Идентификатор проблемы. |
| status | string | Статус проблемы.
Элемент может содержать эти значения
|
| startTime | integer | Отметка времени начала проблемы в миллисекундах UTC. |
| endTime | integer | Отметка времени окончания проблемы в миллисекундах UTC.
Имеет |
| title | string | Название проблемы, отображаемое в пользовательском интерфейсе. |
Объект EntityStub
Краткое представление отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| entityId | EntityId | Краткое представление отслеживаемого объекта. |
| name | string | Имя объекта.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. |
Объект EntityId
Краткое представление отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор объекта. |
| type | string | Тип объекта. |
Объект LinkedProblem
Свойства связанной задачи.
| Элемент | Тип | Описание |
|---|---|---|
| displayId | string | Идентификатор отображения проблемы. |
| details | string | Идентификатор проблемы. |
Объект AlertingProfileStub
Краткое представление профиля предупреждений.
| Элемент | Тип | Описание |
|---|---|---|
| name | string | Имя профиля предупреждений. |
| id | string | Идентификатор профиля оповещения. |
Объект EvidenceDetails
Доказательства подробности проблемы.
| Элемент | Тип | Описание |
|---|---|---|
| totalCount | integer | Общее количество признаков проблемы. |
| details | Evidence[] | Список всех доказательств. |
Объект Evidence
Доказательство первопричины.
Фактический набор полей зависит от типа свидетельства. Найдите список актуальных объектов в описании поляvideType или посмотрите модели Problems API v2-JSON .
| Элемент | Тип | Описание |
|---|---|---|
| evidenceType | string | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
| 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 | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
| impactedEntity | EntityStub | Краткое представление отслеживаемого объекта. |
| estimatedAffectedUsers | integer | Предполагаемое количество затронутых пользователей. |
Объект _ ManagementZone
Краткое представление зоны управления.
| Элемент | Тип | Описание |
|---|---|---|
| имя | string | Имя зоны управления. |
| я бы | string | Идентификатор зоны управления. |
Объект _ METag
Тег отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| представление строки | string | Строковое представление тега. |
| ценность | string | Значение тега. |
| ключ | string | Ключ тега. |
| контекст | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это |
JSON-модель тела ответа
{
"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"
]
}
