Поделиться через

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

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: 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

Пример ответа

Код состояния:
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

Сериализованный в ФОРМАТЕ JSON массив объектов EndpointHealthData со следующей ссылкой.
EndpointHealthStatus

Состояния работоспособности имеют следующие значения. Состояние "работоспособный" показывает, что конечная точка принимает сообщения должным образом. Состояние "неработоспособно" показывает, что конечная точка не принимает сообщения должным образом, и Центр Интернета вещей повторяет попытку отправить данные в эту конечную точку. Состояние неработоспособной конечной точки будет обновлено до работоспособности, когда Центр Интернета вещей установил в конечном итоге согласованное состояние работоспособности. Состояние "мертвый" показывает, что конечная точка не принимает сообщения, после того, как Центр Интернета вещей повторно отправлял сообщения в течение повторного периода. См. метрики Центра Интернета вещей для выявления ошибок и мониторинга проблем с конечными точками. Состояние "неизвестно" показывает, что Центр Интернета вещей не установил подключение к конечной точке. Сообщения не были доставлены в эту конечную точку или отклонены
ErrorDetails

Сведения об ошибке.

EndpointHealthData

Object

Данные о работоспособности конечной точки

Имя Тип Описание
endpointId

string

Идентификатор конечной точки
healthStatus

EndpointHealthStatus

Состояния работоспособности имеют следующие значения. Состояние "работоспособный" показывает, что конечная точка принимает сообщения должным образом. Состояние "неработоспособно" показывает, что конечная точка не принимает сообщения должным образом, и Центр Интернета вещей повторяет попытку отправить данные в эту конечную точку. Состояние неработоспособной конечной точки будет обновлено до работоспособности, когда Центр Интернета вещей установил в конечном итоге согласованное состояние работоспособности. Состояние "мертвый" показывает, что конечная точка не принимает сообщения, после того, как Центр Интернета вещей повторно отправлял сообщения в течение повторного периода. См. метрики Центра Интернета вещей для выявления ошибок и мониторинга проблем с конечными точками. Состояние "неизвестно" показывает, что Центр Интернета вещей не установил подключение к конечной точке. Сообщения не были доставлены в эту конечную точку или отклонены
lastKnownError

string

Последняя ошибка, полученная при сбое доставки сообщения в центр iot
lastKnownErrorTime

string (date-time-rfc1123)

Время, в котором произошла последняя известная ошибка
lastSendAttemptTime

string (date-time-rfc1123)

Последний раз, когда центр iot пытался отправить сообщение в конечную точку
lastSuccessfulSendAttemptTime

string (date-time-rfc1123)

Последний раз, когда центр iot успешно отправил сообщение в конечную точку

EndpointHealthDataListResult

Object

Сериализованный в ФОРМАТЕ JSON массив объектов EndpointHealthData со следующей ссылкой.

Имя Тип Описание
nextLink

string

Ссылка на дополнительные результаты
value

EndpointHealthData[]

Сериализованный массив данных работоспособности конечных точек в формате JSON

EndpointHealthStatus

Перечисление

Состояния работоспособности имеют следующие значения. Состояние "работоспособный" показывает, что конечная точка принимает сообщения должным образом. Состояние "неработоспособно" показывает, что конечная точка не принимает сообщения должным образом, и Центр Интернета вещей повторяет попытку отправить данные в эту конечную точку. Состояние неработоспособной конечной точки будет обновлено до работоспособности, когда Центр Интернета вещей установил в конечном итоге согласованное состояние работоспособности. Состояние "мертвый" показывает, что конечная точка не принимает сообщения, после того, как Центр Интернета вещей повторно отправлял сообщения в течение повторного периода. См. метрики Центра Интернета вещей для выявления ошибок и мониторинга проблем с конечными точками. Состояние "неизвестно" показывает, что Центр Интернета вещей не установил подключение к конечной точке. Сообщения не были доставлены в эту конечную точку или отклонены

Значение Описание
unknown
healthy
degraded
unhealthy
dead

ErrorDetails

Object

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.
details

string

Сведения об ошибке.
httpStatusCode

string

Код состояния HTTP.
message

string

Сообщение об ошибке.