Alerts - Get Summary

參考

Service:: Monitor

API Version:: 2023-07-12-preview

取得依各種參數分組的警示摘要計數 (，例如依「嚴重性」分組，會傳回每個嚴重性) 的警示計數。

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

With optional parameters:

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 參數

名稱	位於	必要	類型	Description
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	依格式/時間格式的自定義時間範圍進行篩選，其中 time 是 (ISO-8601 格式) 』。允許的值介於查詢時間的30天內。您可以使用 timeRange 或 customTimeRange，但不能同時使用這兩者。預設值為 none。
includeSmartGroupsCount	query		boolean	在摘要中包含SmartGroups的計數。默認值為『false』。
monitorCondition	query		MonitorCondition	依「引發」或「已解決」的監視條件進行篩選。預設值為全部選取。
monitorService	query		MonitorService	依產生警示實例的監視服務進行篩選。預設值為全部選取。
severity	query		Severity	依嚴重性篩選。預設值為全部選取。
targetResource	query		string	依目標資源篩選 ( 完整ARM標識碼) 預設值會全部選取。
targetResourceGroup	query		string	依目標資源組名進行篩選。預設值為全部選取。
targetResourceType	query		string	依目標資源類型進行篩選。預設值為全部選取。
timeRange	query		TimeRange	依下列列出的值依時間範圍進行篩選。預設值為1天。

回應

名稱	類型	Description
200 OK	alertsSummary	正常。傳回警示摘要。
Other Status Codes	errorResponse	描述作業失敗原因的錯誤回應。

範例

Summary

Sample Request

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

Sample Response

Status code:: 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"
}

定義

名稱	Description
alertsSummary	根據輸入篩選條件和『groupby』參數的警示摘要。
alertsSummaryGroup	將結果集分組。
AlertsSummaryGroupByFields	此參數可讓結果集依輸入欄位分組， (支援的最大 2 個逗號分隔字段) 。例如，groupby=severity 或 groupby=severity，alertstate。
alertsSummaryGroupItem	警示摘要群組專案
AlertState	警示物件狀態，可由使用者修改。
errorResponse	來自服務的錯誤回應。
errorResponseBody	錯誤回應的詳細數據。
MonitorCondition	監視服務的規則條件。它代表基礎條件是否已超過定義的警示規則閾值。
MonitorService	監視規則設定 (監視) 的服務。
Severity	警示 Sev0 最高且 Sev4 為最低嚴重性。
TimeRange	依下列列出的值依時間範圍進行篩選。預設值為1天。

alertsSummary

根據輸入篩選條件和『groupby』參數的警示摘要。

名稱	類型	Description
id	string	Azure 資源標識碼
name	string	Azure 資源名稱
properties	alertsSummaryGroup	將結果集分組。
type	string	Azure 資源類型

alertsSummaryGroup

將結果集分組。

名稱	類型	Description
groupedby	string	匯總的欄位名稱
smartGroupsCount	integer	智慧群組的總計數。
total	integer	結果集的總計數。
values	alertsSummaryGroupItem[]	項目清單

AlertsSummaryGroupByFields

此參數可讓結果集依輸入欄位分組， (支援的最大 2 個逗號分隔字段) 。例如，groupby=severity 或 groupby=severity，alertstate。

名稱	類型	Description
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

警示摘要群組專案

名稱	類型	Description
count	integer	匯總欄位的計數
groupedby	string	匯總的欄位名稱
name	string	匯總欄位的值
values	alertsSummaryGroupItem[]	項目清單

AlertState

警示物件狀態，可由使用者修改。

名稱	類型	Description
Acknowledged	string
Closed	string
New	string

errorResponse

來自服務的錯誤回應。

名稱	類型	Description
error	errorResponseBody	錯誤回應的詳細數據。

errorResponseBody

錯誤回應的詳細數據。

名稱	類型	Description
code	string	錯誤碼，旨在以程序設計方式取用。
details	errorResponseBody[]	錯誤的其他詳細數據清單。
message	string	錯誤的描述，用於顯示在使用者介面中。
target	string	特定錯誤的目標，例如屬性的名稱。

MonitorCondition

監視服務的規則條件。它代表基礎條件是否已超過定義的警示規則閾值。

名稱	類型	Description
Fired	string
Resolved	string

MonitorService

監視規則設定 (監視) 的服務。

名稱	類型	Description
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 為最低嚴重性。

名稱	類型	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

依下列列出的值依時間範圍進行篩選。預設值為1天。

名稱	類型	Description
1d	string
1h	string
30d	string
7d	string