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	здесь приведен идентификатор ресурса, для которого создается оповещение.
api-version	query	True	string minLength: 1	Версия 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, но не оба. Значение по умолчанию — нет.
includeSmartGroupsCount	query		boolean	Включите количество смарт-групп в составе сводки. Значение по умолчанию — false.
monitorCondition	query		MonitorCondition	Фильтруйте по условию монитора, которое имеет значение "Уволено" или "Разрешено". Значение по умолчанию — выбрать все.
monitorService	query		MonitorService	Фильтрация по службе мониторинга, которая создает экземпляр оповещения. Значение по умолчанию — это все.
severity	query		Severity	Фильтрация по серьезности. Значение по умолчанию — это все.
targetResource	query		string	Фильтруйте по целевому ресурсу (который является полным идентификатором ARM). Значение по умолчанию выбирается все.
targetResourceGroup	query		string	Фильтрация по имени целевой группы ресурсов. Значение по умолчанию — это все.
targetResourceType	query		string	Фильтрация по типу целевого ресурса. Значение по умолчанию — это все.
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

Object

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

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

alertsSummaryGroup

Object

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

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

AlertsSummaryGroupByFields

Перечисление

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

Значение	Описание
alertRule
alertState
monitorCondition
monitorService
severity
signalType

alertsSummaryGroupItem

Object

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

Имя	Тип	Описание
count	integer (int64)	Количество агрегированного поля
groupedby	string	Имя агрегированного поля
name	string	Значение агрегированного поля
values	alertsSummaryGroupItem[]	Список элементов

AlertState

Перечисление

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

Значение	Описание
Acknowledged
Closed
New

errorResponse

Object

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

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

errorResponseBody

Object

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

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

MonitorCondition

Перечисление

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

Значение	Описание
Fired
Resolved

MonitorService

Перечисление

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

Значение	Описание
ActivityLog Administrative
ActivityLog Autoscale
ActivityLog Policy
ActivityLog Recommendation
ActivityLog Security
Application Insights
Log Analytics
Nagios
Platform
Resource Health
SCOM
ServiceHealth
SmartDetector
VM Insights
Zabbix

Severity

Перечисление

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

Значение	Описание
Sev0
Sev1
Sev2
Sev3
Sev4

TimeRange

Перечисление

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

Значение	Описание
1d
1h
30d
7d

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

Alerts - Get Summary

Параметры URI

Ответы

Примеры

Summary

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

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

Определения

alertsSummary

alertsSummaryGroup

AlertsSummaryGroupByFields

alertsSummaryGroupItem

AlertState

errorResponse

errorResponseBody

MonitorCondition

MonitorService

Severity

TimeRange

Дополнительные ресурсы