Alerts - Get Summary

Layanan:: Monitor

Versi API:: 2019-03-01

Dapatkan jumlah ringkasan pemberitahuan Anda yang dikelompokkan berdasarkan 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=2019-03-01

Dengan parameter opsional:

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=2019-03-01

Parameter URI

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

Respons

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

Contoh

Summary

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary?groupby=severity,alertState&api-version=2019-03-01

Respon sampel

Kode status:: 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
AlertsManagementErrorResponse	Respons kesalahan dari layanan.
alertsSummary	Ringkasan peringatan berdasarkan filter input dan parameter 'groupby'.
alertsSummaryGroup	Kelompokkan kumpulan hasil.
AlertsSummaryGroupByFields	Parameter ini memungkinkan kumpulan hasil dikelompokkan berdasarkan bidang input. Misalnya, groupby=severity,alertstate.
alertsSummaryGroupItem	Item grup ringkasan pemberitahuan
AlertState	Status objek peringatan, yang dapat dimodifikasi oleh pengguna.
api-version	Versi API.
errorResponseBody	Detail respons kesalahan.
MonitorCondition	Dapat berupa 'Dipecat' atau 'Diselesaikan', yang mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
MonitorService	Memantau layanan tempat aturan(monitor) ditetapkan.
Severity	Tingkat keparahan peringatan Sev0 tertinggi dan Sev4 terendah.
TimeRange	Filter berdasarkan rentang waktu dengan nilai yang tercantum di bawah ini. Nilai default adalah 1 hari.

AlertsManagementErrorResponse

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	errorResponseBody	Detail respons kesalahan.

alertsSummary

Objek

Ringkasan peringatan 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

Objek

Kelompokkan kumpulan hasil.

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

AlertsSummaryGroupByFields

Enumerasi

Parameter ini memungkinkan kumpulan hasil dikelompokkan berdasarkan bidang input. Misalnya, groupby=severity,alertstate.

Nilai	Deskripsi
severity
alertState
monitorCondition
monitorService
signalType
alertRule

alertsSummaryGroupItem

Objek

Item grup ringkasan pemberitahuan

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

AlertState

Enumerasi

Status objek peringatan, yang dapat dimodifikasi oleh pengguna.

Nilai	Deskripsi
New
Acknowledged
Closed

api-version

Enumerasi

Versi API.

Nilai	Deskripsi
2019-03-01

errorResponseBody

Objek

Detail respons kesalahan.

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

MonitorCondition

Enumerasi

Dapat berupa 'Dipecat' atau 'Diselesaikan', yang mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.

Nilai	Deskripsi
Fired
Resolved

MonitorService

Enumerasi

Memantau layanan tempat aturan(monitor) ditetapkan.

Nilai	Deskripsi
Application Insights
ActivityLog Administrative
ActivityLog Security
ActivityLog Recommendation
ActivityLog Policy
ActivityLog Autoscale
Log Analytics
Nagios
Platform
SCOM
ServiceHealth
SmartDetector
VM Insights
Zabbix
Resource Health

Severity

Enumerasi

Tingkat keparahan peringatan Sev0 tertinggi dan Sev4 terendah.

Nilai	Deskripsi
Sev0
Sev1
Sev2
Sev3
Sev4

TimeRange

Enumerasi

Filter berdasarkan rentang waktu dengan nilai yang tercantum di bawah ini. Nilai default adalah 1 hari.

Nilai	Deskripsi
1h
1d
7d
30d

Bagikan melalui

Alerts - Get Summary

Parameter URI

Respons

Contoh

Summary

Permintaan sampel

Respon sampel

Definisi

AlertsManagementErrorResponse

alertsSummary

alertsSummaryGroup

AlertsSummaryGroupByFields

alertsSummaryGroupItem

AlertState

api-version

errorResponseBody

MonitorCondition

MonitorService

Severity

TimeRange