Alerts - Get Summary

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2023-07-12-preview

Pobierz podsumowaną liczbę alertów pogrupowanych według różnych parametrów (np. grupowanie według ważności zwraca liczbę alertów dla każdej ważności).

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
scope	path	True	string	zakres poniżej to resourceId, dla którego jest tworzony alert.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
groupby	query	True	AlertsSummaryGroupByFields	Ten parametr umożliwia grupowanie zestawu wyników według pól wejściowych (obsługiwane są maksymalnie 2 pola rozdzielane przecinkami). Na przykład groupby=severity lub groupby=severity,alertstate.
alertRule	query		string	Filtruj według określonej reguły alertu. Wartość domyślna to wybranie wszystkich.
alertState	query		AlertState	Filtruj według stanu wystąpienia alertu. Wartość domyślna to wybranie wszystkich.
customTimeRange	query		string	Filtruj według niestandardowego zakresu czasu w formacie/miejscu, w którym znajduje się czas (format ISO-8601)". Dopuszczalne wartości są w ciągu 30 dni od czasu zapytania. Można użyć elementu timeRange lub customTimeRange, ale nie obu. Domyślna wartość to none.
includeSmartGroupsCount	query		boolean	Uwzględnij liczbę grup Inteligentnych w ramach podsumowania. Wartość domyślna to "false".
monitorCondition	query		MonitorCondition	Filtruj według warunku monitora, który jest "wyzwolony" lub "Rozwiązany". Wartość domyślna to wybranie wszystkich.
monitorService	query		MonitorService	Filtruj według usługi monitora, która generuje wystąpienie alertu. Wartość domyślna to wszystkie.
severity	query		Severity	Filtruj według ważności. Wartość domyślna to wszystkie.
targetResource	query		string	Filtruj według zasobu docelowego( który jest pełnym identyfikatorem arm) Wartość domyślna jest wybierana jako wszystkie.
targetResourceGroup	query		string	Filtruj według docelowej nazwy grupy zasobów. Wartość domyślna to wszystkie.
targetResourceType	query		string	Filtruj według typu zasobu docelowego. Wartość domyślna to wszystkie.
timeRange	query		TimeRange	Filtruj według zakresu czasu według wymienionych poniżej wartości. Wartość domyślna to 1 dzień.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	alertsSummary	OK. Zwrócone podsumowanie alertu.
Other Status Codes	errorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

Summary

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
alertsSummary	Podsumowanie alertów na podstawie filtrów wejściowych i parametrów "groupby".
alertsSummaryGroup	Grupuj zestaw wyników.
AlertsSummaryGroupByFields	Ten parametr umożliwia grupowanie zestawu wyników według pól wejściowych (obsługiwane są maksymalnie 2 pola rozdzielane przecinkami). Na przykład groupby=severity lub groupby=severity,alertstate.
alertsSummaryGroupItem	Element grupy podsumowania alertów
AlertState	Stan obiektu alertu, który można zmodyfikować przez użytkownika.
errorResponse	Odpowiedź błędu z usługi.
errorResponseBody	Szczegóły odpowiedzi na błąd.
MonitorCondition	Warunek reguły w usłudze monitora. Określa, czy podstawowe warunki przekroczyły zdefiniowane progi reguły alertu.
MonitorService	Monitoruj usługę, na której ustawiono regułę(monitor).
Severity	Ważność alertu Sev0 jest najwyższa i Sev4 jest najniższa.
TimeRange	Filtruj według zakresu czasu według wymienionych poniżej wartości. Wartość domyślna to 1 dzień.

alertsSummary

Podsumowanie alertów na podstawie filtrów wejściowych i parametrów "groupby".

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure
name	string	Nazwa zasobu platformy Azure
properties	alertsSummaryGroup	Grupuj zestaw wyników.
type	string	Typ zasobu platformy Azure

alertsSummaryGroup

Grupuj zestaw wyników.

Nazwa	Typ	Opis
groupedby	string	Nazwa zagregowanego pola
smartGroupsCount	integer	Łączna liczba grup inteligentnych.
total	integer	Łączna liczba zestawów wyników.
values	alertsSummaryGroupItem[]	Lista elementów

AlertsSummaryGroupByFields

Ten parametr umożliwia grupowanie zestawu wyników według pól wejściowych (obsługiwane są maksymalnie 2 pola rozdzielane przecinkami). Na przykład groupby=severity lub groupby=severity,alertstate.

Nazwa	Typ	Opis
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Element grupy podsumowania alertów

Nazwa	Typ	Opis
count	integer	Liczba zagregowanych pól
groupedby	string	Nazwa zagregowanego pola
name	string	Wartość zagregowanego pola
values	alertsSummaryGroupItem[]	Lista elementów

AlertState

Stan obiektu alertu, który można zmodyfikować przez użytkownika.

Nazwa	Typ	Opis
Acknowledged	string
Closed	string
New	string

errorResponse

Odpowiedź błędu z usługi.

Nazwa	Typ	Opis
error	errorResponseBody	Szczegóły odpowiedzi na błąd.

errorResponseBody

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu, który ma być używany programowo.
details	errorResponseBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Opis błędu przeznaczonego do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu, na przykład nazwa właściwości.

MonitorCondition

Warunek reguły w usłudze monitora. Określa, czy podstawowe warunki przekroczyły zdefiniowane progi reguły alertu.

Nazwa	Typ	Opis
Fired	string
Resolved	string

MonitorService

Monitoruj usługę, na której ustawiono regułę(monitor).

Nazwa	Typ	Opis
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

Ważność alertu Sev0 jest najwyższa i Sev4 jest najniższa.

Nazwa	Typ	Opis
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Filtruj według zakresu czasu według wymienionych poniżej wartości. Wartość domyślna to 1 dzień.

Nazwa	Typ	Opis
1d	string
1h	string
30d	string
7d	string

Udostępnij za pośrednictwem