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

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 参数

名称 必需 类型 说明
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

示例请求

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

定义

名称 说明
EndpointHealthData

终结点的运行状况数据

EndpointHealthDataListResult

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

EndpointHealthStatus

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

ErrorDetails

错误详细信息。

EndpointHealthData

终结点的运行状况数据

名称 类型 说明
endpointId

string

终结点的 ID

healthStatus

EndpointHealthStatus

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

lastKnownError

string

无法将消息传递到 iot 中心时获取的最后一个错误

lastKnownErrorTime

string

上次已知错误的发生时间

lastSendAttemptTime

string

上次 iot 中心尝试向终结点发送消息的时间

lastSuccessfulSendAttemptTime

string

上次 iot 中心成功将消息发送到终结点的时间

EndpointHealthDataListResult

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

名称 类型 说明
nextLink

string

指向更多结果的链接

value

EndpointHealthData[]

终结点运行状况数据的 JSON 序列化数组

EndpointHealthStatus

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

名称 类型 说明
dead

string

degraded

string

healthy

string

unhealthy

string

unknown

string

ErrorDetails

错误详细信息。

名称 类型 说明
code

string

错误代码。

details

string

错误详细信息。

httpStatusCode

string

HTTP 状态代码。

message

string

错误消息。