Devices - Run Command

Služba:

IoT Central

Verze rozhraní API:

2022-07-31

Spuštění příkazu zařízení
Na zařízení spusťte příkaz.

POST https://{subdomain}.{baseDomain}/api/devices/{deviceId}/commands/{commandName}?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.
commandName	path	True	string	Název tohoto příkazu zařízení
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.

Text požadavku

Name	Typ	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Časový limit připojení v sekundách počkejte, než se odpojené zařízení přepojí do režimu online. Výchozí hodnota je 0 sekund.
request		Datová část příkazu zařízení podporuje všechny primitivní typy nebo objekty.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Časový limit odezvy v sekundách počkejte na dokončení příkazu na zařízení. Výchozí hodnota je 30 sekund.

Odpovědi

Name	Typ	Description
201 Created	DeviceCommand	Ú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

Send command

Ukázkový požadavek

HTTP

POST https://appsubdomain.azureiotcentral.com/api/devices/mx1/commands/CoolDown?api-version=2022-07-31

{
  "request": {
    "tempVal": 30
  }
}

Ukázková odpověď

Stavový kód:

201

{}

Definice

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

DeviceCommand

Objekt

Definice příkazu zařízení.

Name	Typ	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Časový limit připojení v sekundách počkejte, než se odpojené zařízení přepojí do režimu online. Výchozí hodnota je 0 sekund.
id	string	ID požadavku spuštění příkazu zařízení.
request		Datová část příkazu zařízení podporuje všechny primitivní typy nebo objekty.
response		Datová část odpovědi příkazu zařízení podporuje všechny primitivní typy nebo objekty.
responseCode	integer (int32)	Stavový kód odpovědi příkazu zařízení.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Časový limit odezvy v sekundách počkejte na dokončení příkazu na zařízení. Výchozí hodnota je 30 sekund.

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.