Iot Hub Resource - Get Endpoint Health

Service:

IoT Hub

API Version:

2018-04-01

Rufen Sie die Integrität für das Routing von Endpunkten ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Antworten

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

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
    }
  ]
}

Definitionen

Name	Beschreibung
EndpointHealthData	Die Integritätsdaten für einen Endpunkt
EndpointHealthDataListResult	Das JSON-serialisierte Array von EndpointHealthData-Objekten mit einem nächsten Link.
EndpointHealthStatus	Der Integritäts- status Code des Endpunkts
ErrorDetails	Fehlerdetails.

EndpointHealthData

Die Integritätsdaten für einen Endpunkt

Name	Typ	Beschreibung
endpointId	string	ID des Endpunkts
healthStatus	EndpointHealthStatus	Der Integritäts- status Code des Endpunkts

EndpointHealthDataListResult

Das JSON-serialisierte Array von EndpointHealthData-Objekten mit einem nächsten Link.

Name	Typ	Beschreibung
nextLink	string	Link zu weiteren Ergebnissen
value	EndpointHealthData[]	JSON-serialisiertes Array von Endpunktintegritätsdaten

EndpointHealthStatus

Der Integritäts- status Code des Endpunkts

Name	Typ	Beschreibung
dead	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.