共用方式為


Iot Hub Resource - Get Endpoint Health

取得路由端點的健康情況。

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

URI 參數

名稱 位於 必要 類型 Description
iotHubName
path True

string

resourceGroupName
path True

string

subscriptionId
path True

string

訂用帳戶標識碼。

api-version
query True

string

API 版本。

回應

名稱 類型 Description
200 OK

EndpointHealthDataListResult

還行

Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

IotHubResource_GetEndpointHealth

範例要求

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

範例回覆

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

定義

名稱 Description
EndpointHealthData

端點的健康情況數據

EndpointHealthDataListResult

具有下一個連結的 EndpointHealthData 物件的 JSON 串行化數位。

EndpointHealthStatus

健康狀態具有下列意義。 「狀況良好」狀態會顯示端點正在如預期般接受訊息。 「狀況不良」狀態會顯示端點未如預期般接受訊息,且IoT中樞正在重試將數據傳送至此端點。 當IoT中樞已建立最終一致的健康狀態時,狀況不良端點的狀態將會更新為狀況良好。 在 IoT 中樞在重試重試傳送訊息之後,「死」狀態會顯示端點不接受訊息。 請參閱IoT中樞計量,以識別錯誤並監視端點的問題。 「未知」狀態顯示IoT中樞尚未建立與端點的連線。 未從此端點傳遞或拒絕任何訊息

ErrorDetails

錯誤詳細數據。

EndpointHealthData

端點的健康情況數據

名稱 類型 Description
endpointId

string

端點的標識碼

healthStatus

EndpointHealthStatus

健康狀態具有下列意義。 「狀況良好」狀態會顯示端點正在如預期般接受訊息。 「狀況不良」狀態會顯示端點未如預期般接受訊息,且IoT中樞正在重試將數據傳送至此端點。 當IoT中樞已建立最終一致的健康狀態時,狀況不良端點的狀態將會更新為狀況良好。 在 IoT 中樞在重試重試傳送訊息之後,「死」狀態會顯示端點不接受訊息。 請參閱IoT中樞計量,以識別錯誤並監視端點的問題。 「未知」狀態顯示IoT中樞尚未建立與端點的連線。 未從此端點傳遞或拒絕任何訊息

lastKnownError

string

當訊息無法傳遞至 iot 中樞時取得的最後一個錯誤

lastKnownErrorTime

string (date-time-rfc1123)

發生最後一個已知錯誤的時間

lastSendAttemptTime

string (date-time-rfc1123)

上次iot中樞嘗試將訊息傳送至端點的時間

lastSuccessfulSendAttemptTime

string (date-time-rfc1123)

上次iot中樞成功將訊息傳送至端點的時間

EndpointHealthDataListResult

具有下一個連結的 EndpointHealthData 物件的 JSON 串行化數位。

名稱 類型 Description
nextLink

string

連結至更多結果

value

EndpointHealthData[]

端點健康情況數據的 JSON 串行化數位

EndpointHealthStatus

健康狀態具有下列意義。 「狀況良好」狀態會顯示端點正在如預期般接受訊息。 「狀況不良」狀態會顯示端點未如預期般接受訊息,且IoT中樞正在重試將數據傳送至此端點。 當IoT中樞已建立最終一致的健康狀態時,狀況不良端點的狀態將會更新為狀況良好。 在 IoT 中樞在重試重試傳送訊息之後,「死」狀態會顯示端點不接受訊息。 請參閱IoT中樞計量,以識別錯誤並監視端點的問題。 「未知」狀態顯示IoT中樞尚未建立與端點的連線。 未從此端點傳遞或拒絕任何訊息

Description
dead
degraded
healthy
unhealthy
unknown

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

string

錯誤碼。

details

string

錯誤詳細數據。

httpStatusCode

string

HTTP 狀態代碼。

message

string

錯誤訊息。