Iot Hub Resource - Get Endpoint Health

Service:

IoT Hub

API Version:

2018-04-01

Hämta hälsotillståndet för routningsslutpunkter.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Svar

Name	Typ	Description
200 OK	EndpointHealthDataListResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
EndpointHealthData	Hälsodata för en slutpunkt
EndpointHealthDataListResult	Den JSON-serialiserade matrisen med EndpointHealthData-objekt med en nästa länk.
EndpointHealthStatus	Slutpunktens hälsostatuskod
ErrorDetails	Felinformation.

EndpointHealthData

Hälsodata för en slutpunkt

Name	Typ	Description
endpointId	string	ID för slutpunkten
healthStatus	EndpointHealthStatus	Slutpunktens hälsostatuskod

EndpointHealthDataListResult

Den JSON-serialiserade matrisen med EndpointHealthData-objekt med en nästa länk.

Name	Typ	Description
nextLink	string	Länka till fler resultat
value	EndpointHealthData[]	JSON-serialiserad matris med slutpunktshälsodata

EndpointHealthStatus

Slutpunktens hälsostatuskod

Name	Typ	Description
dead	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.