Devices - Get

Služba:

IoT Central

Verze rozhraní API:

2022-07-31

Získat zařízení podle ID
Získejte podrobnosti o existujícím zařízení podle ID zařízení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
baseDomain	path	True	string	Základní doména pro všechny požadavky služby Azure IoT Central.
deviceId	path	True	string	Jedinečné ID zařízení
subdomain	path	True	string	Subdoména aplikace.
api-version	query	True	string	Verze volaného rozhraní API.

Odpovědi

Name	Typ	Description
200 OK	Device	Úspěch
Other Status Codes	Error	Odpověď na chybu přijatá ze služby IoT Central Hlavičky x-ms-error-code: string

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get device by ID

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
Device	Definice zařízení.
Error	Definice chyby odpovědi.
ErrorDetails	Podrobné informace o chybě.

Device

Objekt

Definice zařízení.

Name	Typ	Description
displayName	string	Zobrazovaný název zařízení.
enabled	boolean	Jestli je povolené připojení zařízení ke službě IoT Central.
etag	string	ETag sloužící k zabránění konfliktům v aktualizacích zařízení.
id	string	Jedinečné ID zařízení
organizations	string[]	Seznam ID organizace, na které je zařízení součástí, se dnes podporuje jenom jedna organizace, brzy bude podporováno více organizací.
provisioned	boolean	Určuje, jestli byly pro zařízení přiděleny prostředky.
simulated	boolean	Určuje, jestli je zařízení simulované.
template	string	Definice šablony zařízení pro zařízení.

Error

Objekt

Definice chyby odpovědi.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Objekt

Podrobné informace o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Podrobnosti o chybové zprávě
requestId	string	ID korelace pro aktuální požadavek
time	string (date-time-rfc1123)	Čas, kdy se žádost o chybu nezdařila.