次の方法で共有


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

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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 Hubはこのエンドポイントにデータを送信するために再試行しています。 IoT Hub が最終的に一貫して正常状態を確立すると、異常なエンドポイントの状態が "正常" に更新されます。 "配信不能" 状態は、再審期間中にメッセージの送信を再試行IoT Hub後、エンドポイントがメッセージを受け入れないことを示します。 エラーを特定し、エンドポイントに関する問題を監視するには、「メトリックのIoT Hub」を参照してください。 "不明" 状態は、IoT Hubがエンドポイントとの接続を確立していないことを示しています。 このエンドポイントへのメッセージの配信または拒否は行われません

ErrorDetails

エラーの詳細。

EndpointHealthData

エンドポイントの正常性データ

名前 説明
endpointId

string

エンドポイントの ID

healthStatus

EndpointHealthStatus

正常性状態には、次の意味があります。 "正常" 状態は、エンドポイントが期待どおりにメッセージを受け入れることを示しています。 "異常" 状態は、エンドポイントが想定どおりにメッセージを受け入れていないことを示し、IoT Hubはこのエンドポイントにデータを送信するために再試行しています。 IoT Hub が最終的に一貫して正常状態を確立すると、異常なエンドポイントの状態が "正常" に更新されます。 "配信不能" 状態は、再審期間中にメッセージの送信を再試行IoT Hub後、エンドポイントがメッセージを受け入れないことを示します。 エラーを特定し、エンドポイントに関する問題を監視するには、「メトリックのIoT Hub」を参照してください。 "不明" 状態は、IoT Hubがエンドポイントとの接続を確立していないことを示しています。 このエンドポイントへのメッセージの配信または拒否は行われません

lastKnownError

string

メッセージを iot ハブに配信できなかった場合に取得された最後のエラー

lastKnownErrorTime

string

最後の既知のエラーが発生した時刻

lastSendAttemptTime

string

IoT ハブがエンドポイントにメッセージを送信しようとした最後の時刻

lastSuccessfulSendAttemptTime

string

IoT ハブがエンドポイントにメッセージを正常に送信した最後の時刻

EndpointHealthDataListResult

次のリンクを含む EndpointHealthData オブジェクトの JSON でシリアル化された配列。

名前 説明
nextLink

string

その他の結果へのリンク

value

EndpointHealthData[]

エンドポイント正常性データの JSON シリアル化された配列

EndpointHealthStatus

正常性状態には、次の意味があります。 "正常" 状態は、エンドポイントが期待どおりにメッセージを受け入れることを示しています。 "異常" 状態は、エンドポイントが想定どおりにメッセージを受け入れていないことを示し、IoT Hubはこのエンドポイントにデータを送信するために再試行しています。 IoT Hub が最終的に一貫して正常状態を確立すると、異常なエンドポイントの状態が "正常" に更新されます。 "配信不能" 状態は、再審期間中にメッセージの送信を再試行IoT Hub後、エンドポイントがメッセージを受け入れないことを示します。 エラーを特定し、エンドポイントに関する問題を監視するには、「メトリックのIoT Hub」を参照してください。 "不明" 状態は、IoT Hubがエンドポイントとの接続を確立していないことを示しています。 このエンドポイントへのメッセージの配信または拒否は行われません

名前 説明
dead

string

degraded

string

healthy

string

unhealthy

string

unknown

string

ErrorDetails

エラーの詳細。

名前 説明
code

string

エラー コード。

details

string

エラーの詳細です。

httpStatusCode

string

HTTP 状態コード。

message

string

エラー メッセージ。