Freigeben über


Iot Hub Resource - Get Endpoint Health

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=2023-06-30

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

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_GetEndpointHealth

Beispielanforderung

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

Beispiel für eine Antwort

{
  "value": [
    {
      "endpointId": "id1",
      "healthStatus": "healthy",
      "lastSuccessfulSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT",
      "lastSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT"
    },
    {
      "endpointId": "id2",
      "healthStatus": "unknown"
    },
    {
      "endpointId": "id3",
      "healthStatus": "unhealthy",
      "lastKnownError": "NotFound",
      "lastKnownErrorTime": "Wed, 13 Sep 2022 18:04:32 GMT",
      "lastSuccessfulSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT",
      "lastSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT"
    }
  ]
}

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

Integritätsstatus haben folgende Bedeutungen. Die "fehlerfreie" status zeigt an, dass der Endpunkt Nachrichten wie erwartet akzeptiert. Die status "fehlerhaft" zeigt, dass der Endpunkt keine Nachrichten wie erwartet akzeptiert, und IoT Hub versucht erneut, Daten an diesen Endpunkt zu senden. Der Status eines fehlerhaften Endpunkts wird zu fehlerfrei aktualisiert, wenn IoT Hub einen möglicherweise konsistenten Integritätsstatus erreicht hat. Die "tote" status zeigt, dass der Endpunkt keine Nachrichten akzeptiert, nachdem IoT Hub nachrichten für den Wiederholungszeitraum erneut gesendet hat. Informationen zum Identifizieren von Fehlern und zum Überwachen von Endpunktproblemen finden Sie unter IoT Hub Metriken. Die status "unbekannt" zeigt, dass der IoT Hub keine Verbindung mit dem Endpunkt hergestellt hat. Es wurden keine Nachrichten an diesen Endpunkt übermittelt oder abgelehnt.

ErrorDetails

Fehlerdetails.

EndpointHealthData

Die Integritätsdaten für einen Endpunkt

Name Typ Beschreibung
endpointId

string

ID des Endpunkts

healthStatus

EndpointHealthStatus

Integritätsstatus haben folgende Bedeutungen. Die "fehlerfreie" status zeigt an, dass der Endpunkt Nachrichten wie erwartet akzeptiert. Die status "fehlerhaft" zeigt, dass der Endpunkt keine Nachrichten wie erwartet akzeptiert, und IoT Hub versucht erneut, Daten an diesen Endpunkt zu senden. Der Status eines fehlerhaften Endpunkts wird zu fehlerfrei aktualisiert, wenn IoT Hub einen möglicherweise konsistenten Integritätsstatus erreicht hat. Die "tote" status zeigt, dass der Endpunkt keine Nachrichten akzeptiert, nachdem IoT Hub nachrichten für den Wiederholungszeitraum erneut gesendet hat. Informationen zum Identifizieren von Fehlern und zum Überwachen von Endpunktproblemen finden Sie unter IoT Hub Metriken. Die status "unbekannt" zeigt, dass der IoT Hub keine Verbindung mit dem Endpunkt hergestellt hat. Es wurden keine Nachrichten an diesen Endpunkt übermittelt oder abgelehnt.

lastKnownError

string

Letzter Fehler, der erhalten wurde, wenn eine Nachricht nicht an iot Hub übermittelt werden konnte

lastKnownErrorTime

string

Zeitpunkt, zu dem der letzte bekannte Fehler aufgetreten ist

lastSendAttemptTime

string

Beim letzten Versuch von iot Hub, eine Nachricht an den Endpunkt zu senden

lastSuccessfulSendAttemptTime

string

Das letzte Mal, wenn iot hub erfolgreich eine Nachricht an den Endpunkt gesendet hat

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

Integritätsstatus haben folgende Bedeutungen. Die "fehlerfreie" status zeigt an, dass der Endpunkt Nachrichten wie erwartet akzeptiert. Die status "fehlerhaft" zeigt, dass der Endpunkt keine Nachrichten wie erwartet akzeptiert, und IoT Hub versucht erneut, Daten an diesen Endpunkt zu senden. Der Status eines fehlerhaften Endpunkts wird zu fehlerfrei aktualisiert, wenn IoT Hub einen möglicherweise konsistenten Integritätsstatus erreicht hat. Die "tote" status zeigt, dass der Endpunkt keine Nachrichten akzeptiert, nachdem IoT Hub nachrichten für den Wiederholungszeitraum erneut gesendet hat. Informationen zum Identifizieren von Fehlern und zum Überwachen von Endpunktproblemen finden Sie unter IoT Hub Metriken. Die status "unbekannt" zeigt, dass der IoT Hub keine Verbindung mit dem Endpunkt hergestellt hat. Es wurden keine Nachrichten an diesen Endpunkt übermittelt oder abgelehnt.

Name Typ Beschreibung
dead

string

degraded

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.