你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 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，但不能同时使用这两者。默认值为 none。
includeSmartGroupsCount	query		boolean	在摘要中包含 SmartGroups 的计数。默认值为“false”。
monitorCondition	query		MonitorCondition	按“已触发”或“已解决”的监视条件进行筛选。默认值为全选。
monitorService	query		MonitorService	按生成警报实例的监视服务进行筛选。默认值全选。
severity	query		Severity	按严重性筛选。默认值全选。
targetResource	query		string	按目标资源（即完整的 ARM ID）进行筛选，默认值全部选中。
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	监视在其中设置规则（monitor）的服务。
Severity	警报 Sev0 的最高严重性和 Sev4 的严重性最低。
TimeRange	按以下列出的值按时间范围进行筛选。默认值为 1 天。

alertsSummary

Object

基于输入筛选器和“groupby”参数的警报摘要。

名称	类型	说明
id	string	Azure 资源 ID
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

枚举

监视在其中设置规则（monitor）的服务。

值	说明
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