Devices - Run Command

Usługa:

IoT Central

Wersja interfejsu API:

2022-07-31

Uruchamianie polecenia urządzenia
Uruchom polecenie na urządzeniu.

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

Parametry identyfikatora URI

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

Treść żądania

Nazwa	Typ	Opis
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Limit czasu połączenia w sekundach oczekiwania na połączenie urządzenia, które zostanie odłączone, będzie dostępne w trybie online. Wartość domyślna to 0 sekund.
request		Ładunek polecenia urządzenia obsługuje dowolne typy pierwotne lub obiekty.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Limit czasu odpowiedzi w sekundach oczekiwania na ukończenie polecenia na urządzeniu. Wartość domyślna to 30 sekund.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	DeviceCommand	Powodzenie
Other Status Codes	Error	Odebrano odpowiedź o błędzie z usługi IoT Central. Nagłówki x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ protokołu 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

Send command

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

201

{}

Definicje

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

DeviceCommand

Objekt

Definicja polecenia urządzenia.

Nazwa	Typ	Opis
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Limit czasu połączenia w sekundach oczekiwania na połączenie urządzenia, które zostanie odłączone, będzie dostępne w trybie online. Wartość domyślna to 0 sekund.
id	string	Identyfikator żądania wykonania polecenia urządzenia.
request		Ładunek polecenia urządzenia obsługuje dowolne typy pierwotne lub obiekty.
response		Ładunek odpowiedzi polecenia urządzenia, obsługuje wszelkie typy pierwotne lub obiekty.
responseCode	integer (int32)	Kod stanu odpowiedzi polecenia urządzenia.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Limit czasu odpowiedzi w sekundach oczekiwania na ukończenie polecenia na urządzeniu. Wartość domyślna to 30 sekund.

Error

Objekt

Definicja błędu odpowiedzi.

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

ErrorDetails

Objekt

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 (date-time-rfc1123)	Czas niepowodzenia żądania błędu.