Alerts - Get Summary

Referensi

Service:: Monitor

API Version:: 2023-07-12-preview

Dapatkan jumlah ringkasan pemberitahuan Anda yang dikelompokkan menurut berbagai parameter (misalnya pengelompokan menurut 'Tingkat Keparahan' mengembalikan jumlah pemberitahuan untuk setiap tingkat keparahan).

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
scope	path	True	string	cakupan di sini adalah resourceId yang pemberitahuannya dibuat.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
groupby	query	True	AlertsSummaryGroupByFields	Parameter ini memungkinkan tataan hasil dikelompokkan menurut bidang input (Maksimum 2 bidang yang dipisahkan koma yang didukung). Misalnya, groupby=severity atau groupby=severity,alertstate.
alertRule	query		string	Filter menurut aturan pemberitahuan tertentu. Nilai defaultnya adalah memilih semua.
alertState	query		AlertState	Filter menurut status instans pemberitahuan. Nilai defaultnya adalah memilih semua.
customTimeRange	query		string	Filter menurut rentang waktu kustom dalam format / di mana waktu berada dalam (format ISO-8601)'. Nilai yang diizinkan dalam waktu 30 hari sejak waktu kueri. TimeRange atau customTimeRange dapat digunakan tetapi tidak keduanya. Defaultnya adalah tidak ada.
includeSmartGroupsCount	query		boolean	Sertakan jumlah SmartGroups sebagai bagian dari ringkasan. Nilai defaultnya adalah 'false'.
monitorCondition	query		MonitorCondition	Filter menurut kondisi monitor yang 'Diaktifkan' atau 'Diselesaikan'. Nilai defaultnya adalah memilih semua.
monitorService	query		MonitorService	Filter menurut layanan monitor yang menghasilkan instans pemberitahuan. Nilai defaultnya adalah pilih semua.
severity	query		Severity	Filter menurut tingkat keparahan. Nilai defaultnya adalah pilih semua.
targetResource	query		string	Filter menurut sumber daya target( yang merupakan ARM ID penuh) Nilai default adalah pilih semua.
targetResourceGroup	query		string	Filter menurut nama grup sumber daya target. Nilai defaultnya adalah pilih semua.
targetResourceType	query		string	Filter menurut jenis sumber daya target. Nilai defaultnya adalah pilih semua.
timeRange	query		TimeRange	Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

Respons

Nama	Jenis	Deskripsi
200 OK	alertsSummary	OK. Ringkasan pemberitahuan dikembalikan.
Other Status Codes	errorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

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"
}

Definisi

Nama	Deskripsi
alertsSummary	Ringkasan pemberitahuan berdasarkan filter input dan parameter 'groupby'.
alertsSummaryGroup	Kelompokkan kumpulan hasil.
AlertsSummaryGroupByFields	Parameter ini memungkinkan tataan hasil dikelompokkan menurut bidang input (Maksimum 2 bidang yang dipisahkan koma yang didukung). Misalnya, groupby=severity atau groupby=severity,alertstate.
alertsSummaryGroupItem	Item grup ringkasan pemberitahuan
AlertState	Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.
errorResponse	Respons kesalahan dari layanan.
errorResponseBody	Detail respons kesalahan.
MonitorCondition	Kondisi aturan di layanan monitor. Ini mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
MonitorService	Memantau layanan tempat aturan (monitor) diatur.
Severity	Tingkat keparahan pemberitahuan Sev0 tertinggi dan Sev4 terendah.
TimeRange	Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

alertsSummary

Ringkasan pemberitahuan berdasarkan filter input dan parameter 'groupby'.

Nama	Jenis	Deskripsi
id	string	Id sumber daya Azure
name	string	Nama sumber daya Azure
properties	alertsSummaryGroup	Kelompokkan kumpulan hasil.
type	string	Jenis sumber daya Azure

alertsSummaryGroup

Kelompokkan kumpulan hasil.

Nama	Jenis	Deskripsi
groupedby	string	Nama bidang yang diagregasi
smartGroupsCount	integer	Jumlah total grup pintar.
total	integer	Jumlah total kumpulan hasil.
values	alertsSummaryGroupItem[]	Daftar item

AlertsSummaryGroupByFields

Parameter ini memungkinkan tataan hasil dikelompokkan menurut bidang input (Maksimum 2 bidang yang dipisahkan koma yang didukung). Misalnya, groupby=severity atau groupby=severity,alertstate.

Nama	Jenis	Deskripsi
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Item grup ringkasan pemberitahuan

Nama	Jenis	Deskripsi
count	integer	Jumlah bidang agregat
groupedby	string	Nama bidang yang diagregasi
name	string	Nilai bidang agregat
values	alertsSummaryGroupItem[]	Daftar item

AlertState

Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.

Nama	Jenis	Deskripsi
Acknowledged	string
Closed	string
New	string

errorResponse

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	errorResponseBody	Detail respons kesalahan.

errorResponseBody

Detail respons kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan, dimaksudkan untuk dikonsumsi secara terprogram.
details	errorResponseBody[]	Daftar detail tambahan tentang kesalahan tersebut.
message	string	Deskripsi kesalahan, ditujukan untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu, misalnya nama properti.

MonitorCondition

Kondisi aturan di layanan monitor. Ini mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.

Nama	Jenis	Deskripsi
Fired	string
Resolved	string

MonitorService

Memantau layanan tempat aturan (monitor) diatur.

Nama	Jenis	Deskripsi
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

Tingkat keparahan pemberitahuan Sev0 tertinggi dan Sev4 terendah.

Nama	Jenis	Deskripsi
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

Nama	Jenis	Deskripsi
1d	string
1h	string
30d	string
7d	string