你当前正在访问 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	要用于此操作的 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	将 SmartGroup 计数作为摘要的一部分包含在内。默认值为“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	设置规则 (监视) 的监视服务。
Severity	警报的严重性 Sev0 最高，Sev4 为最低。
TimeRange	按以下列出的值按时间范围进行筛选。默认值为 1 天。

alertsSummary

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

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

通过