你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Iot Hub Resource - Get Endpoint Health

服务:: IoT Hub

API 版本:: 2023-06-30

获取路由终结点的运行状况。

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

URI 参数

名称	在	必需	类型	说明
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

响应

名称	类型	说明
200 OK	EndpointHealthDataListResult	还行
Other Status Codes	ErrorDetails	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

IotHubResource_GetEndpointHealth

示例请求

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

示例响应

状态代码:: 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"
    }
  ]
}

定义

名称	说明
EndpointHealthData	终结点的运行状况数据
EndpointHealthDataListResult	包含下一个链接的 EndpointHealthData 对象的 JSON 序列化数组。
EndpointHealthStatus	运行状况具有以下含义。 “正常”状态显示终结点正在按预期接受消息。 “不正常”状态显示终结点未按预期接受消息，IoT 中心正在重试将数据发送到此终结点。当 IoT 中心建立最终一致的运行状况状态时，不正常的终结点的状态将更新为正常。 “死”状态显示，在 IoT 中心重试发送重审期间的消息后，终结点不接受消息。请参阅 IoT 中心指标来识别错误并监视终结点的问题。 “未知”状态显示 IoT 中心尚未与终结点建立连接。未向此终结点传递或拒绝任何消息
ErrorDetails	错误详细信息。

EndpointHealthData

Object

终结点的运行状况数据

名称	类型	说明
endpointId	string	终结点的 ID
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

Object

包含下一个链接的 EndpointHealthData 对象的 JSON 序列化数组。

名称	类型	说明
nextLink	string	链接到更多结果
value	EndpointHealthData[]	终结点运行状况数据的 JSON 序列化数组

EndpointHealthStatus

枚举

运行状况具有以下含义。 “正常”状态显示终结点正在按预期接受消息。 “不正常”状态显示终结点未按预期接受消息，IoT 中心正在重试将数据发送到此终结点。当 IoT 中心建立最终一致的运行状况状态时，不正常的终结点的状态将更新为正常。 “死”状态显示，在 IoT 中心重试发送重审期间的消息后，终结点不接受消息。请参阅 IoT 中心指标来识别错误并监视终结点的问题。 “未知”状态显示 IoT 中心尚未与终结点建立连接。未向此终结点传递或拒绝任何消息

值	说明
unknown
healthy
degraded
unhealthy
dead

ErrorDetails

Object

错误详细信息。

名称	类型	说明
code	string	错误代码。
details	string	错误详细信息。
httpStatusCode	string	HTTP 状态代码。
message	string	错误消息。

通过

Iot Hub Resource - Get Endpoint Health

URI 参数

响应

安全性

azure_auth

作用域

示例

IotHubResource_GetEndpointHealth

示例请求

示例响应

定义

EndpointHealthData

EndpointHealthDataListResult

EndpointHealthStatus

ErrorDetails