Region Healths - Get

Usługa:

Azure Stack Admin

Wersja interfejsu API:

2016-05-01

Zwraca żądany stan kondycji regionu.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}?api-version=2016-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
location	path	True	string	Nazwa regionu
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RegionHealth	OK

Zabezpieczenia

azure_auth

Autoryzacja używa przepływu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Returns the requested health status of a region.

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local?api-version=2016-05-01

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local",
  "name": "local",
  "type": "Microsoft.InfrastructureInsights.Admin/regionHealths",
  "location": "local",
  "tags": {},
  "properties": {
    "usageMetrics": [
      {
        "name": "Physical memory",
        "metricsValue": [
          {
            "name": "Used",
            "unit": "GB",
            "value": 76.24941635131836
          },
          {
            "name": "Available",
            "unit": "GB",
            "value": 181.7333984375
          }
        ]
      },
      {
        "name": "Physical storage",
        "metricsValue": [
          {
            "name": "Used",
            "unit": "TB",
            "value": 0.22170669212937355
          },
          {
            "name": "Available",
            "unit": "TB",
            "value": 2.2449070774018764
          }
        ]
      },
      {
        "name": "Public IP address pools",
        "metricsValue": [
          {
            "name": "Used",
            "unit": "One",
            "value": 31
          },
          {
            "name": "Available",
            "unit": "One",
            "value": 480
          }
        ]
      }
    ],
    "alertSummary": {
      "criticalAlertCount": 0,
      "warningAlertCount": 2
    }
  }
}

Definicje

Nazwa	Opis
AlertSummary	Podsumowanie alertów.
Metrics	Metryki dla źródła.
MetricsSourceType	Początek metryki.
MetricsUnit	Jednostka metryki.
RegionHealth	Zawiera informacje dotyczące kondycji regionu.
UsageMetrics	Metryki użycia zasobów.

AlertSummary

Objekt

Podsumowanie alertów.

Nazwa	Typ	Opis
criticalAlertCount	integer	Liczba alertów krytycznych dla usługi.
warningAlertCount	integer	Liczba alertów ostrzegawczych dla usługi.

Metrics

Objekt

Metryki dla źródła.

Nazwa	Typ	Opis
maCounterName	string	Nazwa licznika.
name	string	Nazwa metryki użycia.
observedTimestamp	string (date-time)	Zaobserwowano licznik czasu.
sourceName	MetricsSourceType	Nazwa źródła.
sourceType	string	Typ źródła.
unit	MetricsUnit	Jednostka metryki.
value	number (double)	Nazwa metryki użycia.

MetricsSourceType

Wyliczanie

Początek metryki.

Wartość	Opis
PhysicalNode
VirtualMachine
ResourceProvider

MetricsUnit

Wyliczanie

Jednostka metryki.

Wartość	Opis
One
Percentage
B
KB
MB
GB
TB

RegionHealth

Objekt

Zawiera informacje dotyczące kondycji regionu.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu
location	string	Region świadczenia usługi Azure, w którym znajduje się zasób
name	string	Nazwa zasobu
properties.alertSummary	AlertSummary	Podsumowanie alertów.
properties.usageMetrics	UsageMetrics[]	Lista metryk użycia dla regionu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

UsageMetrics

Objekt

Metryki użycia zasobów.

Nazwa	Typ	Opis
metricsValue	Metrics[]	Lista metryk użycia.
name	string	Nazwa metryki użycia.