Network Status - List By Service

Služba:: API Management

Verze rozhraní API:: 2024-05-01

Získá stav připojení k externím prostředkům, na kterých služba Api Management závisí v rámci cloudové služby. Tím se také vrátí servery DNS, které jsou viditelné pro CloudService.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus?api-version=2024-05-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	NetworkStatusContractByLocation[]	Získá seznam Podrobnosti o stavu sítě pro všechny oblasti, ve kterých je služba nasazena.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementServiceGetNetworkStatus

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/networkstatus?api-version=2024-05-01

Ukázková odpověď

Stavový kód:: 200

[
  {
    "location": "Central US EUAP",
    "networkStatus": {
      "dnsServers": [
        "168.63.129.16"
      ],
      "connectivityStatus": [
        {
          "name": "apimst8rlxXXXXX7.queue.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:44.6399168Z",
          "lastStatusChange": "2023-05-25T03:53:44.1786214Z",
          "resourceType": "SmtpQueue",
          "isOptional": true
        },
        {
          "name": "apimstm5lkXXXXX4kky0.blob.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:39:33.9426753Z",
          "lastStatusChange": "2023-05-25T03:53:44.1786214Z",
          "resourceType": "BlobStorage",
          "isOptional": false
        },
        {
          "name": "apimstm5lkXXXXX4kky0.file.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:38.9993574Z",
          "lastStatusChange": "2023-05-25T03:53:43.8953621Z",
          "resourceType": "FileStorage",
          "isOptional": true
        },
        {
          "name": "apimstm5lkXXXXX4kky0.queue.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:38.4368875Z",
          "lastStatusChange": "2023-05-25T03:53:44.2081238Z",
          "resourceType": "Queue",
          "isOptional": true
        },
        {
          "name": "apimstm5lkXXXXX4kky0.table.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:17.4762359Z",
          "lastStatusChange": "2023-05-25T03:53:43.9734877Z",
          "resourceType": "TableStorage",
          "isOptional": false
        },
        {
          "name": "apirpsqlmgsXXXXXXic45.database.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:50.2954792Z",
          "lastStatusChange": "2023-05-25T03:53:44.0704109Z",
          "resourceType": "SQLDatabase",
          "isOptional": false
        },
        {
          "name": "gcs.prod.monitoring.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:09.8448385Z",
          "lastStatusChange": "2023-05-25T03:53:43.8484895Z",
          "resourceType": "Monitoring",
          "isOptional": false
        },
        {
          "name": "https://apikv-XXXXXXurugl3.vault.azure.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:17.3447288Z",
          "lastStatusChange": "2023-06-02T06:54:45.7125288Z",
          "resourceType": "AzureKeyVault",
          "isOptional": false
        },
        {
          "name": "https://centraluseuap.login.microsoft.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:01.6660359Z",
          "lastStatusChange": "2023-05-25T03:53:44.1490292Z",
          "resourceType": "RegionalAzureActiveDirectory",
          "isOptional": true
        },
        {
          "name": "https://gcs.prod.warm.ingestion.monitoring.azure.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:42:08.0050056Z",
          "lastStatusChange": "2023-05-26T14:09:26.2508948Z",
          "resourceType": "Monitoring",
          "isOptional": true
        },
        {
          "name": "https://global.prod.microsoftmetrics.com/",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:12.9698299Z",
          "lastStatusChange": "2023-05-25T03:53:44.1297766Z",
          "resourceType": "Monitoring",
          "isOptional": true
        },
        {
          "name": "https://login.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:43.4048644Z",
          "lastStatusChange": "2023-06-04T11:10:16.1041673Z",
          "resourceType": "AzureActiveDirectory",
          "isOptional": true
        },
        {
          "name": "https://partner.prod.repmap.microsoft.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:32.6067213Z",
          "lastStatusChange": "2023-05-25T03:53:44.2081238Z",
          "resourceType": "CaptchaEndpoint",
          "isOptional": true
        },
        {
          "name": "https://xxxxx.prod.microsoftmetrics.com:1886/RecoveryService",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:42:33.8566303Z",
          "lastStatusChange": "2023-05-25T03:53:44.3488261Z",
          "resourceType": "Metrics",
          "isOptional": true
        },
        {
          "name": "https://samir-XXXXXXX.management.azure-api.net:3443/servicestatus?api-version=2018-01-01",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:42:10.3954682Z",
          "lastStatusChange": "2023-06-08T16:42:10.3954682Z",
          "resourceType": "ApiManagement Control Plane - inbound",
          "isOptional": false
        },
        {
          "name": "LocalGatewayRedis",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:39:30.184537Z",
          "lastStatusChange": "2023-05-25T03:53:44.2081238Z",
          "resourceType": "InternalCache",
          "isOptional": true
        },
        {
          "name": "Scm",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:24.6623693Z",
          "lastStatusChange": "2023-05-25T03:32:02.6480516Z",
          "resourceType": "SourceControl",
          "isOptional": true
        }
      ]
    }
  }
]

Definice

Name	Description
ConnectivityStatusContract	Podrobnosti o připojení k prostředku
ConnectivityStatusType	Identifikátor typu stavu připojení prostředku.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
NetworkStatusContract	Podrobnosti o stavu sítě
NetworkStatusContractByLocation	Stav sítě v umístění

ConnectivityStatusContract

Objekt

Podrobnosti o připojení k prostředku

Name	Typ	Description
error	string	Podrobnosti o chybě připojení k prostředku
isOptional	boolean	Bez ohledu na to, jestli je tato možnost volitelná.
lastStatusChange	string (date-time)	Datum, kdy se stav připojení prostředku naposledy změnil z úspěchu na selhání nebo naopak. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
lastUpdated	string (date-time)	Datum poslední aktualizace stavu připojení prostředku. Tento stav by se měl aktualizovat každých 15 minut. Pokud se tento stav neaktualizoval, znamená to, že služba ztratila síťové připojení k prostředku z virtuální sítě. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle standardu ISO 8601.
name	string minLength: 1	Název hostitele prostředku, na kterém služba závisí. Může se jednat o databázi, úložiště nebo jakýkoli jiný prostředek Azure, na kterém služba závisí.
resourceType	string	Typ prostředku.
status	ConnectivityStatusType	Identifikátor typu stavu připojení prostředku.

ConnectivityStatusType

Výčet

Identifikátor typu stavu připojení prostředku.

Hodnota	Description
initializing
success
failure

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

NetworkStatusContract

Objekt

Podrobnosti o stavu sítě

Name	Typ	Description
connectivityStatus	ConnectivityStatusContract[]	Získá seznam stavu připojení k prostředkům, na kterých služba závisí.
dnsServers	string[]	Získá seznam IPV4 serverů DNS.

NetworkStatusContractByLocation

Objekt

Stav sítě v umístění

Name	Typ	Description
location	string minLength: 1	Umístění služby
networkStatus	NetworkStatusContract	Stav sítě v umístění

Sdílet prostřednictvím

Network Status - List By Service

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementServiceGetNetworkStatus

Ukázkový požadavek

Ukázková odpověď

Definice

ConnectivityStatusContract

ConnectivityStatusType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NetworkStatusContract

NetworkStatusContractByLocation