共用方式為


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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

範例

IotHubResource_GetEndpointHealth

Sample Request

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

Sample Response

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

發生上次已知錯誤的時間

lastSendAttemptTime

string

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

lastSuccessfulSendAttemptTime

string

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

EndpointHealthDataListResult

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

名稱 類型 Description
nextLink

string

連結至更多結果

value

EndpointHealthData[]

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

EndpointHealthStatus

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

名稱 類型 Description
dead

string

degraded

string

healthy

string

unhealthy

string

unknown

string

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

string

錯誤碼。

details

string

錯誤詳細資料。

httpStatusCode

string

HTTP 狀態碼。

message

string

錯誤訊息。