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 매개 변수

Name	In(다음 안에)	필수	형식	Description
scope	path	True	string	scope 경고가 생성되는 resourceId입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
groupby	query	True	AlertsSummaryGroupByFields	이 매개 변수를 사용하면 결과 집합을 입력 필드별로 그룹화할 수 있습니다(최대 2개의 쉼표로 구분된 필드가 지원됨). 예를 들어 groupby=severity 또는 groupby=severity,alertstate입니다.
alertRule	query		string	특정 경고 규칙을 기준으로 필터링합니다. 기본값은 모두를 선택하는 것입니다.
alertState	query		AlertState	경고 instance 상태를 기준으로 필터링합니다. 기본값은 모두를 선택하는 것입니다.
customTimeRange	query		string	시간(ISO-8601 형식)의 형식/위치로 사용자 지정 시간 범위를 기준으로 필터링합니다. 허용되는 값은 쿼리 시간으로부터 30일 이내입니다. timeRange 또는 customTimeRange를 사용할 수 있지만 둘 다 사용할 수는 없습니다. 기본값은 none입니다.
includeSmartGroupsCount	query		boolean	요약의 일부로 SmartGroups 수를 포함합니다. 기본값은 'false'입니다.
monitorCondition	query		MonitorCondition	'발생' 또는 '해결됨'인 모니터 조건으로 필터링합니다. 기본값은 모두를 선택하는 것입니다.
monitorService	query		MonitorService	경고 instance 생성하는 모니터 서비스별로 필터링합니다. 기본값은 모두 선택입니다.
severity	query		Severity	심각도를 기준으로 필터링합니다. 기본값은 모두 선택입니다.
targetResource	query		string	대상 리소스(전체 ARM ID)로 필터링 기본값이 모두 선택됩니다.
targetResourceGroup	query		string	대상 리소스 그룹 이름을 기준으로 필터링합니다. 기본값은 모두 선택입니다.
targetResourceType	query		string	대상 리소스 종류별로 필터링합니다. 기본값은 모두 선택입니다.
timeRange	query		TimeRange	아래 나열된 값을 기준으로 시간 범위를 기준으로 필터링합니다. 기본값은 1일입니다.

응답

Name	형식	Description
200 OK	alertsSummary	OK. 경고 요약이 반환되었습니다.
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"
}

정의

Name	Description
alertsSummary	입력 필터 및 'groupby' 매개 변수를 기반으로 하는 경고의 요약입니다.
alertsSummaryGroup	결과 집합을 그룹화합니다.
AlertsSummaryGroupByFields	이 매개 변수를 사용하면 결과 집합을 입력 필드별로 그룹화할 수 있습니다(최대 2개의 쉼표로 구분된 필드가 지원됨). 예를 들어 groupby=severity 또는 groupby=severity,alertstate입니다.
alertsSummaryGroupItem	경고 요약 그룹 항목
AlertState	사용자가 수정할 수 있는 경고 개체 상태입니다.
errorResponse	서비스의 오류 응답입니다.
errorResponseBody	오류 응답에 대한 세부 정보입니다.
MonitorCondition	모니터 서비스의 규칙 조건입니다. 기본 조건이 정의된 경고 규칙 임계값을 초과했는지 여부를 나타냅니다.
MonitorService	규칙(모니터)이 설정된 서비스를 모니터링합니다.
Severity	경고 Sev0의 심각도가 가장 높고 Sev4가 가장 낮습니다.
TimeRange	아래 나열된 값을 기준으로 시간 범위를 기준으로 필터링합니다. 기본값은 1일입니다.

alertsSummary

입력 필터 및 'groupby' 매개 변수를 기반으로 하는 경고의 요약입니다.

Name	형식	Description
id	string	Azure 리소스 ID
name	string	Azure 리소스 이름
properties	alertsSummaryGroup	결과 집합을 그룹화합니다.
type	string	Azure 리소스 종류

alertsSummaryGroup

결과 집합을 그룹화합니다.

Name	형식	Description
groupedby	string	집계된 필드의 이름
smartGroupsCount	integer	스마트 그룹의 총 수입니다.
total	integer	결과 집합의 총 수입니다.
values	alertsSummaryGroupItem[]	항목 목록

AlertsSummaryGroupByFields

이 매개 변수를 사용하면 결과 집합을 입력 필드별로 그룹화할 수 있습니다(최대 2개의 쉼표로 구분된 필드가 지원됨). 예를 들어 groupby=severity 또는 groupby=severity,alertstate입니다.

Name	형식	Description
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

경고 요약 그룹 항목

Name	형식	Description
count	integer	집계된 필드의 수
groupedby	string	집계된 필드의 이름
name	string	집계된 필드의 값
values	alertsSummaryGroupItem[]	항목 목록

AlertState

사용자가 수정할 수 있는 경고 개체 상태입니다.

Name	형식	Description
Acknowledged	string
Closed	string
New	string

errorResponse

서비스의 오류 응답입니다.

Name	형식	Description
error	errorResponseBody	오류 응답에 대한 세부 정보입니다.

errorResponseBody

오류 응답에 대한 세부 정보입니다.

Name	형식	Description
code	string	프로그래밍 방식으로 사용할 오류 코드입니다.
details	errorResponseBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기 위한 오류에 대한 설명입니다.
target	string	특정 오류의 대상(예: 속성 이름).

MonitorCondition

모니터 서비스의 규칙 조건입니다. 기본 조건이 정의된 경고 규칙 임계값을 초과했는지 여부를 나타냅니다.

Name	형식	Description
Fired	string
Resolved	string

MonitorService

규칙(모니터)이 설정된 서비스를 모니터링합니다.

Name	형식	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가 가장 낮습니다.

Name	형식	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

아래 나열된 값을 기준으로 시간 범위를 기준으로 필터링합니다. 기본값은 1일입니다.

Name	형식	Description
1d	string
1h	string
30d	string
7d	string