Alerts - Get Summary

Ссылка

Служба:: Monitor

Версия API:: 2023-07-12-preview

Получите сводные данные о количестве оповещений, сгруппированных по различным параметрам (например, при группировке по серьезности возвращается количество оповещений для каждого уровня серьезности).

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&api-version=2023-07-12-preview

С использованием необязательных параметров:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&includeSmartGroupsCount={includeSmartGroupsCount}&targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&timeRange={timeRange}&customTimeRange={customTimeRange}&api-version=2023-07-12-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
scope	path	True	string	область здесь — resourceId, для которого создается оповещение.
api-version	query	True	string	Версия API, используемая для данной операции.
groupby	query	True	AlertsSummaryGroupByFields	Этот параметр позволяет сгруппировать результирующий набор по полям ввода (поддерживается максимум 2 поля с разделиемыми запятыми). Например, groupby=severity или groupby=severity,alertstate.
alertRule	query		string	Фильтрация по определенному правилу генерации оповещений. Значение по умолчанию — выбрать все.
alertState	query		AlertState	Фильтрация по состоянию экземпляра оповещения. Значение по умолчанию — выбрать все.
customTimeRange	query		string	Фильтрация по пользовательскому диапазону времени в формате / где время находится в (формат ISO-8601)". Допустимые значения — в течение 30 дней с момента выполнения запроса. Можно использовать timeRange или customTimeRange, но не оба. Значение по умолчанию — none (Отсутствует).
includeSmartGroupsCount	query		boolean	Включите число групп SmartGroup в сводку. Значение по умолчанию — false.
monitorCondition	query		MonitorCondition	Фильтрация по условию монитора, которое имеет значение "Сработало" или "Разрешено". Значение по умолчанию — выбрать все.
monitorService	query		MonitorService	Фильтрация по службе мониторинга, которая создает экземпляр оповещения. Значение по умолчанию — select all.
severity	query		Severity	Фильтрация по серьезности. Значение по умолчанию — select all.
targetResource	query		string	Фильтрация по целевому ресурсу (полный идентификатор ARM). Значение по умолчанию — выбрать все.
targetResourceGroup	query		string	Фильтрация по имени целевой группы ресурсов. Значение по умолчанию — select all.
targetResourceType	query		string	Фильтрация по типу целевого ресурса. Значение по умолчанию — select all.
timeRange	query		TimeRange	Фильтрация по диапазону времени по приведенным ниже значениям. Значение по умолчанию — 1 день.

Ответы

Имя	Тип	Описание
200 OK	alertsSummary	Все в порядке. Возвращена сводка оповещений.
Other Status Codes	errorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Примеры

Summary

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary?groupby=severity,alertState&api-version=2023-07-12-preview

Пример ответа

Код состояния:: 200

{
  "properties": {
    "groupedby": "severity",
    "smartGroupsCount": 100,
    "total": 14189,
    "values": [
      {
        "name": "Sev0",
        "count": 6517,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 6517
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev1",
        "count": 3175,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 3175
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev2",
        "count": 1120,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1120
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev3",
        "count": 1902,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1902
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev4",
        "count": 1475,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1475
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current",
  "type": "Microsoft.AlertsManagement/alertsSummary",
  "name": "current"
}

Определения

Имя	Описание
alertsSummary	Сводка оповещений на основе входных фильтров и параметров groupby.
alertsSummaryGroup	Группирование результирующих наборов.
AlertsSummaryGroupByFields	Этот параметр позволяет сгруппировать результирующий набор по полям ввода (поддерживается максимум 2 поля с разделиемыми запятыми). Например, groupby=severity или groupby=severity,alertstate.
alertsSummaryGroupItem	Элемент сводной группы оповещений
AlertState	Состояние объекта оповещения, которое может быть изменено пользователем.
errorResponse	Ответ об ошибке от службы.
errorResponseBody	Сведения об ответе на ошибку.
MonitorCondition	Условие правила в службе мониторинга. Он указывает, пересекли ли базовые условия определенные пороговые значения правил генерации оповещений.
MonitorService	Служба мониторинга, для которой задано правило (монитор).
Severity	Уровень серьезности оповещения Sev0 — самый высокий, а Sev4 — самый низкий.
TimeRange	Фильтрация по диапазону времени по приведенным ниже значениям. Значение по умолчанию — 1 день.

alertsSummary

Сводка оповещений на основе входных фильтров и параметров groupby.

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure
name	string	Имя ресурса Azure
properties	alertsSummaryGroup	Группирование результирующих наборов.
type	string	Тип ресурса Azure

alertsSummaryGroup

Группирование результирующих наборов.

Имя	Тип	Описание
groupedby	string	Имя агрегированного поля
smartGroupsCount	integer	Общее количество смарт-групп.
total	integer	Общее число результирующих наборов.
values	alertsSummaryGroupItem[]	Список элементов

AlertsSummaryGroupByFields

Этот параметр позволяет сгруппировать результирующий набор по полям ввода (поддерживается максимум 2 поля с разделиемыми запятыми). Например, groupby=severity или groupby=severity,alertstate.

Имя	Тип	Описание
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Элемент сводной группы оповещений

Имя	Тип	Описание
count	integer	Число агрегированных полей
groupedby	string	Имя агрегированного поля
name	string	Значение агрегированного поля
values	alertsSummaryGroupItem[]	Список элементов

AlertState

Состояние объекта оповещения, которое может быть изменено пользователем.

Имя	Тип	Описание
Acknowledged	string
Closed	string
New	string

errorResponse

Ответ об ошибке от службы.

Имя	Тип	Описание
error	errorResponseBody	Сведения об ответе на ошибку.

errorResponseBody

Сведения об ответе на ошибку.

Имя	Тип	Описание
code	string	Код ошибки, предназначенный для программного использования.
details	errorResponseBody[]	Список дополнительных сведений об ошибке.
message	string	Описание ошибки, предназначенной для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки, например имя свойства.

MonitorCondition

Условие правила в службе мониторинга. Он указывает, пересекли ли базовые условия определенные пороговые значения правил генерации оповещений.

Имя	Тип	Описание
Fired	string
Resolved	string

MonitorService

Служба мониторинга, для которой задано правило (монитор).

Имя	Тип	Описание
ActivityLog Administrative	string
ActivityLog Autoscale	string
ActivityLog Policy	string
ActivityLog Recommendation	string
ActivityLog Security	string
Application Insights	string
Log Analytics	string
Nagios	string
Platform	string
Resource Health	string
SCOM	string
ServiceHealth	string
SmartDetector	string
VM Insights	string
Zabbix	string

Severity

Уровень серьезности оповещения Sev0 — самый высокий, а Sev4 — самый низкий.

Имя	Тип	Описание
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Фильтрация по диапазону времени по приведенным ниже значениям. Значение по умолчанию — 1 день.

Имя	Тип	Описание
1d	string
1h	string
30d	string
7d	string

Поделиться через