Iot Hub Resource - Get Endpoint Health

Ottenere l'integrità per gli endpoint di routing.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
iotHubName
path True

string

resourceGroupName
path True

string

subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione dell'API.

Risposte

Nome Tipo Descrizione
200 OK

EndpointHealthDataListResult

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

IotHubResource_GetEndpointHealth

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
EndpointHealthData

Dati di integrità per un endpoint

EndpointHealthDataListResult

Matrice serializzata JSON di oggetti EndpointHealthData con un collegamento successivo.

EndpointHealthStatus

Gli stati di integrità hanno significati seguenti. Lo stato "integro" indica che l'endpoint accetta i messaggi come previsto. Lo stato "non integro" indica che l'endpoint non accetta i messaggi come previsto e hub IoT sta ritentando di inviare dati a questo endpoint. Lo stato di un endpoint non integro verrà aggiornato a integro quando l'hub IoT avrà stabilito alla fine uno stato di integrità coerente. Lo stato "dead" indica che l'endpoint non accetta messaggi, dopo hub IoT ritentare l'invio dei messaggi per il periodo di ripetizione. Vedere hub IoT metriche per identificare gli errori e monitorare i problemi relativi agli endpoint. Lo stato 'unknown' indica che il hub IoT non ha stabilito una connessione con l'endpoint. Nessun messaggio recapitato o rifiutato da questo endpoint

ErrorDetails

Dettagli errore.

EndpointHealthData

Dati di integrità per un endpoint

Nome Tipo Descrizione
endpointId

string

ID dell'endpoint

healthStatus

EndpointHealthStatus

Gli stati di integrità hanno significati seguenti. Lo stato "integro" indica che l'endpoint accetta i messaggi come previsto. Lo stato "non integro" indica che l'endpoint non accetta i messaggi come previsto e hub IoT sta ritentando di inviare dati a questo endpoint. Lo stato di un endpoint non integro verrà aggiornato a integro quando l'hub IoT avrà stabilito alla fine uno stato di integrità coerente. Lo stato "dead" indica che l'endpoint non accetta messaggi, dopo hub IoT ritentare l'invio dei messaggi per il periodo di ripetizione. Vedere hub IoT metriche per identificare gli errori e monitorare i problemi relativi agli endpoint. Lo stato 'unknown' indica che il hub IoT non ha stabilito una connessione con l'endpoint. Nessun messaggio recapitato o rifiutato da questo endpoint

lastKnownError

string

Ultimo errore ottenuto quando non è stato possibile recapitare un messaggio all'hub iot

lastKnownErrorTime

string

Ora in cui si è verificato l'ultimo errore noto

lastSendAttemptTime

string

Ultima volta che l'hub iot ha tentato di inviare un messaggio all'endpoint

lastSuccessfulSendAttemptTime

string

Ultima volta che l'hub iot ha inviato un messaggio all'endpoint

EndpointHealthDataListResult

Matrice serializzata JSON di oggetti EndpointHealthData con un collegamento successivo.

Nome Tipo Descrizione
nextLink

string

Collegamento a altri risultati

value

EndpointHealthData[]

Matrice serializzata JSON dei dati di integrità degli endpoint

EndpointHealthStatus

Gli stati di integrità hanno significati seguenti. Lo stato "integro" indica che l'endpoint accetta i messaggi come previsto. Lo stato "non integro" indica che l'endpoint non accetta i messaggi come previsto e hub IoT sta ritentando di inviare dati a questo endpoint. Lo stato di un endpoint non integro verrà aggiornato a integro quando l'hub IoT avrà stabilito alla fine uno stato di integrità coerente. Lo stato "dead" indica che l'endpoint non accetta messaggi, dopo hub IoT ritentare l'invio dei messaggi per il periodo di ripetizione. Vedere hub IoT metriche per identificare gli errori e monitorare i problemi relativi agli endpoint. Lo stato 'unknown' indica che il hub IoT non ha stabilito una connessione con l'endpoint. Nessun messaggio recapitato o rifiutato da questo endpoint

Nome Tipo Descrizione
dead

string

degraded

string

healthy

string

unhealthy

string

unknown

string

ErrorDetails

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore.

details

string

Dettagli dell'errore.

httpStatusCode

string

Codice di stato HTTP.

message

string

Messaggio di errore.