Iot Hub Resource - Get Endpoint Health

Szolgáltatás:

IoT Hub

API-verzió:

2023-06-30

Az útválasztási végpontok állapotának lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Válaszok

Name	Típus	Description
200 OK	EndpointHealthDataListResult	OKÉ
Other Status Codes	ErrorDetails	DefaultErrorResponse

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

IotHubResource_GetEndpointHealth

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
EndpointHealthData	A végpont állapotadatai
EndpointHealthDataListResult	Az EndpointHealthData-objektumok JSON-szerializált tömbje egy következő hivatkozással.
EndpointHealthStatus	Az állapotok jelentése a következő. Az "kifogástalan" állapot azt mutatja, hogy a végpont a várt módon fogadja az üzeneteket. A "nem kifogástalan" állapot azt mutatja, hogy a végpont nem fogadja el az üzeneteket a várt módon, és az IoT Hub újra megpróbál adatokat küldeni erre a végpontra. A nem kifogástalan végpont állapota kifogástalan állapotúra frissül, ha az IoT Hub végül konzisztens állapotot alakított ki. A "halott" állapot azt mutatja, hogy a végpont nem fogad üzeneteket, miután az IoT Hub újrapróbálkozott az újrapróbálkozási időszakra vonatkozó üzenetek küldésével. Tekintse meg az IoT Hub-metrikákat a hibák azonosításához és a végpontokkal kapcsolatos problémák monitorozásához. Az "ismeretlen" állapot azt mutatja, hogy az IoT Hub nem létesített kapcsolatot a végponttal. Nem lett kézbesítve vagy elutasítva üzenet a végpontról
ErrorDetails	Hiba részletei.

EndpointHealthData

Objektum

A végpont állapotadatai

Name	Típus	Description
endpointId	string	A végpont azonosítója
healthStatus	EndpointHealthStatus	Az állapotok jelentése a következő. Az "kifogástalan" állapot azt mutatja, hogy a végpont a várt módon fogadja az üzeneteket. A "nem kifogástalan" állapot azt mutatja, hogy a végpont nem fogadja el az üzeneteket a várt módon, és az IoT Hub újra megpróbál adatokat küldeni erre a végpontra. A nem kifogástalan végpont állapota kifogástalan állapotúra frissül, ha az IoT Hub végül konzisztens állapotot alakított ki. A "halott" állapot azt mutatja, hogy a végpont nem fogad üzeneteket, miután az IoT Hub újrapróbálkozott az újrapróbálkozási időszakra vonatkozó üzenetek küldésével. Tekintse meg az IoT Hub-metrikákat a hibák azonosításához és a végpontokkal kapcsolatos problémák monitorozásához. Az "ismeretlen" állapot azt mutatja, hogy az IoT Hub nem létesített kapcsolatot a végponttal. Nem lett kézbesítve vagy elutasítva üzenet a végpontról
lastKnownError	string	Az utolsó hibaüzenet, amely akkor jelenik meg, ha egy üzenetet nem sikerült kézbesíteni az iot hubra
lastKnownErrorTime	string (date-time-rfc1123)	Az utolsó ismert hiba előfordulásának időpontja
lastSendAttemptTime	string (date-time-rfc1123)	Legutóbb, amikor az iot hub megpróbált üzenetet küldeni a végpontnak
lastSuccessfulSendAttemptTime	string (date-time-rfc1123)	Legutóbb, amikor az iot hub sikeresen küldött üzenetet a végpontnak

EndpointHealthDataListResult

Objektum

Az EndpointHealthData-objektumok JSON-szerializált tömbje egy következő hivatkozással.

Name	Típus	Description
nextLink	string	További eredményekre mutató hivatkozás
value	EndpointHealthData[]	Végpontállapot-adatok JSON-szerializált tömbje

EndpointHealthStatus

Enumerálás

Az állapotok jelentése a következő. Az "kifogástalan" állapot azt mutatja, hogy a végpont a várt módon fogadja az üzeneteket. A "nem kifogástalan" állapot azt mutatja, hogy a végpont nem fogadja el az üzeneteket a várt módon, és az IoT Hub újra megpróbál adatokat küldeni erre a végpontra. A nem kifogástalan végpont állapota kifogástalan állapotúra frissül, ha az IoT Hub végül konzisztens állapotot alakított ki. A "halott" állapot azt mutatja, hogy a végpont nem fogad üzeneteket, miután az IoT Hub újrapróbálkozott az újrapróbálkozási időszakra vonatkozó üzenetek küldésével. Tekintse meg az IoT Hub-metrikákat a hibák azonosításához és a végpontokkal kapcsolatos problémák monitorozásához. Az "ismeretlen" állapot azt mutatja, hogy az IoT Hub nem létesített kapcsolatot a végponttal. Nem lett kézbesítve vagy elutasítva üzenet a végpontról

Érték	Description
unknown
healthy
degraded
unhealthy
dead

ErrorDetails

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hibakód.
details	string	A hiba részletei.
httpStatusCode	string	A HTTP-állapotkód.
message	string	A hibaüzenet.