Iot Hub Resource - Get Endpoint Health

參考

Service:: IoT Hub

API Version:: 2018-04-01

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

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

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

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "endpointId": "id1",
      "healthStatus": "healthy"
    },
    {
      "endpointId": "id2",
      "healthStatus": "unknown"
    }
  ]
}

定義

名稱	Description
EndpointHealthData	端點的健康情況數據
EndpointHealthDataListResult	EndpointHealthData 物件的 JSON 串行化陣列，具有下一個連結。
EndpointHealthStatus	端點的健康情況狀態代碼
ErrorDetails	錯誤詳細數據。

EndpointHealthData

端點的健康情況數據

名稱	類型	Description
endpointId	string	端點的標識碼
healthStatus	EndpointHealthStatus	端點的健康情況狀態代碼

EndpointHealthDataListResult

EndpointHealthData 物件的 JSON 串行化陣列，具有下一個連結。

名稱	類型	Description
nextLink	string	連結至更多結果
value	EndpointHealthData[]	端點健康情況數據的 JSON 串行化數位

EndpointHealthStatus

端點的健康情況狀態代碼

名稱	類型	Description
dead	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

錯誤詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	string	錯誤詳細資料。
httpStatusCode	string	HTTP 狀態碼。
message	string	錯誤訊息。