Iot Hub Resource - Get Endpoint Health

Service:

IoT Hub

API Version:

2018-04-01

Získejte stav koncových bodů směrování.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth?api-version=2018-04-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Odpovědi

Name	Typ	Description
200 OK	EndpointHealthDataListResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Příklady

IotHubResource_GetEndpointHealth

Sample Request

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/routingEndpointsHealth?api-version=2018-04-01

Sample Response

Status code:

200

{
  "value": [
    {
      "endpointId": "id1",
      "healthStatus": "healthy"
    },
    {
      "endpointId": "id2",
      "healthStatus": "unknown"
    }
  ]
}

Definice

Name	Description
EndpointHealthData	Data o stavu koncového bodu
EndpointHealthDataListResult	Serializované pole JSON objektů EndpointHealthData s dalším odkazem.
EndpointHealthStatus	Stavový kód koncového bodu
ErrorDetails	Podrobnosti o chybě.

EndpointHealthData

Data o stavu koncového bodu

Name	Typ	Description
endpointId	string	ID koncového bodu
healthStatus	EndpointHealthStatus	Stavový kód koncového bodu

EndpointHealthDataListResult

Serializované pole JSON objektů EndpointHealthData s dalším odkazem.

Name	Typ	Description
nextLink	string	Odkaz na další výsledky
value	EndpointHealthData[]	Serializované pole json dat o stavu koncového bodu

EndpointHealthStatus

Stavový kód koncového bodu

Name	Typ	Description
dead	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP
message	string	Chybová zpráva