Partager via


Iot Hub Resource - Get Endpoint Health

Obtenez l’intégrité des points de terminaison de routage.

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

Paramètres URI

Nom Dans Obligatoire Type Description
iotHubName
path True

string

resourceGroupName
path True

string

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l’API.

Réponses

Nom Type Description
200 OK

EndpointHealthDataListResult

Ok

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

IotHubResource_GetEndpointHealth

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
EndpointHealthData

Données d’intégrité d’un point de terminaison

EndpointHealthDataListResult

Tableau sérialisé JSON d’objets EndpointHealthData avec un lien suivant.

EndpointHealthStatus

Les états d’intégrité ont les significations suivantes. Le status « sain » indique que le point de terminaison accepte les messages comme prévu. Le status « non sain » indique que le point de terminaison n’accepte pas les messages comme prévu et IoT Hub tente à nouveau d’envoyer des données à ce point de terminaison. L’état d’un point de terminaison non sain doit être mis à jour vers l’état sain si IoT Hub a établi un état cohérent d’intégrité. Le status « mort » indique que le point de terminaison n’accepte pas les messages, après IoT Hub retenté en envoyant des messages pour la période de nouvelle évaluation. Consultez IoT Hub métriques pour identifier les erreurs et surveiller les problèmes liés aux points de terminaison. Le status « inconnu » indique que le IoT Hub n’a pas établi de connexion avec le point de terminaison. Aucun message n’a été remis ou rejeté à partir de ce point de terminaison

ErrorDetails

Détails de l’erreur.

EndpointHealthData

Données d’intégrité d’un point de terminaison

Nom Type Description
endpointId

string

ID du point de terminaison

healthStatus

EndpointHealthStatus

Les états d’intégrité ont les significations suivantes. Le status « sain » indique que le point de terminaison accepte les messages comme prévu. Le status « non sain » indique que le point de terminaison n’accepte pas les messages comme prévu et IoT Hub tente à nouveau d’envoyer des données à ce point de terminaison. L’état d’un point de terminaison non sain doit être mis à jour vers l’état sain si IoT Hub a établi un état cohérent d’intégrité. Le status « mort » indique que le point de terminaison n’accepte pas les messages, après IoT Hub retenté en envoyant des messages pour la période de nouvelle évaluation. Consultez IoT Hub métriques pour identifier les erreurs et surveiller les problèmes liés aux points de terminaison. Le status « inconnu » indique que le IoT Hub n’a pas établi de connexion avec le point de terminaison. Aucun message n’a été remis ou rejeté à partir de ce point de terminaison

lastKnownError

string

Dernière erreur obtenue lorsqu’un message n’a pas pu être remis au hub iot

lastKnownErrorTime

string

Heure à laquelle la dernière erreur connue s’est produite

lastSendAttemptTime

string

Dernière fois que le hub iot a essayé d’envoyer un message au point de terminaison

lastSuccessfulSendAttemptTime

string

Dernière fois que le hub iot a correctement envoyé un message au point de terminaison

EndpointHealthDataListResult

Tableau sérialisé JSON d’objets EndpointHealthData avec un lien suivant.

Nom Type Description
nextLink

string

Lien vers d’autres résultats

value

EndpointHealthData[]

Tableau sérialisé JSON de données d’intégrité du point de terminaison

EndpointHealthStatus

Les états d’intégrité ont les significations suivantes. Le status « sain » indique que le point de terminaison accepte les messages comme prévu. Le status « non sain » indique que le point de terminaison n’accepte pas les messages comme prévu et IoT Hub tente à nouveau d’envoyer des données à ce point de terminaison. L’état d’un point de terminaison non sain doit être mis à jour vers l’état sain si IoT Hub a établi un état cohérent d’intégrité. Le status « mort » indique que le point de terminaison n’accepte pas les messages, après IoT Hub retenté en envoyant des messages pour la période de nouvelle évaluation. Consultez IoT Hub métriques pour identifier les erreurs et surveiller les problèmes liés aux points de terminaison. Le status « inconnu » indique que le IoT Hub n’a pas établi de connexion avec le point de terminaison. Aucun message n’a été remis ou rejeté à partir de ce point de terminaison

Nom Type Description
dead

string

degraded

string

healthy

string

unhealthy

string

unknown

string

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.