Devices - Run Command

Layanan:

IoT Central

Versi API:

2022-07-31

Menjalankan perintah perangkat
Jalankan perintah pada perangkat.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
baseDomain	path	True	string	Domain dasar untuk semua permintaan layanan Azure IoT Central.
commandName	path	True	string	Nama perintah perangkat ini.
deviceId	path	True	string	ID unik perangkat.
subdomain	path	True	string	Subdomain aplikasi.
api-version	query	True	string	Versi API yang dipanggil.

Isi Permintaan

Nama	Jenis	Deskripsi
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Batas waktu koneksi dalam hitungan detik untuk menunggu perangkat yang terputus menjadi online. Default ke 0 detik.
request		Payload untuk perintah perangkat, mendukung jenis atau objek primitif apa pun.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Waktu respons habis dalam hitungan detik untuk menunggu penyelesaian perintah pada perangkat. Default ke 30 detik.

Respons

Nama	Jenis	Deskripsi
201 Created	DeviceCommand	Keberhasilan
Other Status Codes	Error	Respons kesalahan diterima dari IoT Central Service. Header x-ms-error-code: string

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Send command

Permintaan sampel

HTTP

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

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

Respon sampel

Kode status:

201

{}

Definisi

Nama	Deskripsi
DeviceCommand	Definisi perintah perangkat.
Error	Definisi kesalahan respons.
ErrorDetails	Informasi detail kesalahan.

DeviceCommand

Objek

Definisi perintah perangkat.

Nama	Jenis	Deskripsi
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Batas waktu koneksi dalam hitungan detik untuk menunggu perangkat yang terputus menjadi online. Default ke 0 detik.
id	string	ID permintaan eksekusi perintah perangkat.
request		Payload untuk perintah perangkat, mendukung jenis atau objek primitif apa pun.
response		Payload respons perintah perangkat, mendukung jenis atau objek primitif apa pun.
responseCode	integer (int32)	Kode status respons perintah perangkat.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Waktu respons habis dalam hitungan detik untuk menunggu penyelesaian perintah pada perangkat. Default ke 30 detik.

Error

Objek

Definisi kesalahan respons.

Nama	Jenis	Deskripsi
error	ErrorDetails	Detail kesalahan untuk permintaan saat ini.

ErrorDetails

Objek

Informasi detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Detail pesan kesalahan.
requestId	string	Id Korelasi untuk permintaan saat ini.
time	string (date-time-rfc1123)	Waktu permintaan kesalahan gagal.