Devices - Get

Usługa:

IoT Central

Wersja interfejsu API:

2022-07-31

Pobieranie urządzenia według identyfikatora
Uzyskaj szczegółowe informacje o istniejącym urządzeniu według identyfikatora urządzenia.

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
baseDomain	path	True	string	Domena podstawowa dla wszystkich żądań usług usługi Azure IoT Central.
deviceId	path	True	string	Unikatowy identyfikator urządzenia.
subdomain	path	True	string	Poddomena aplikacji.
api-version	query	True	string	Wywoływana wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Device	Powodzenie
Other Status Codes	Error	Odpowiedź o błędzie odebrana z usługi IoT Central. Nagłówki x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get device by ID

Przykładowe żądanie

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

Definicje

Nazwa	Opis
Device	Definicja urządzenia.
Error	Definicja błędu odpowiedzi.
ErrorDetails	Szczegółowe informacje o błędzie.

Device

Definicja urządzenia.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana urządzenia.
enabled	boolean	Czy połączenie urządzenia z usługą IoT Central zostało włączone.
etag	string	ETag używany do zapobiegania konfliktom w aktualizacjach urządzeń.
id	string	Unikatowy identyfikator urządzenia.
organizations	string[]	Lista identyfikatorów organizacji, które urządzenie jest częścią, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.
provisioned	boolean	Określa, czy zasoby zostały przydzielone dla urządzenia.
simulated	boolean	Czy urządzenie jest symulowane.
template	string	Definicja szablonu urządzenia dla urządzenia.

Error

Definicja błędu odpowiedzi.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Szczegóły komunikatu o błędzie.
requestId	string	Identyfikator korelacji dla bieżącego żądania.
time	string	Czas niepowodzenia żądania błędu.