Devices - Run Command

Hizmet:

IoT Central

API Sürümü:

2022-07-31

Cihaz komutu çalıştırma
Cihazda bir komut çalıştırın.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
baseDomain	path	True	string	Tüm Azure IoT Central hizmet istekleri için temel etki alanı.
commandName	path	True	string	Bu cihaz komutunun adı.
deviceId	path	True	string	Cihazın benzersiz kimliği.
subdomain	path	True	string	Uygulama alt etki alanı.
api-version	query	True	string	Çağrılan API'nin sürümü.

İstek Gövdesi

Name	Tür	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Bağlantısı kesilmiş bir cihazın çevrimiçi olmasını beklemek için saniyeler içinde bağlantı zaman aşımı. Varsayılan değer 0 saniyedir.
request		Cihaz komutunun yükü, tüm temel türleri veya nesneleri destekler.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Bir cihazda komutun tamamlanmasını beklemek için saniye cinsinden yanıt zaman aşımı. Varsayılan değer 30 saniyedir.

Yanıtlar

Name	Tür	Description
201 Created	DeviceCommand	Başarı
Other Status Codes	Error	IoT Central Hizmetinden alınan bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Send command

Örnek isteği

HTTP

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

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

Örnek yanıt

Durum kodu:

201

{}

Tanımlar

Name	Description
DeviceCommand	Cihaz komut tanımı.
Error	Yanıt hatası tanımı.
ErrorDetails	Hatanın ayrıntılı bilgileri.

DeviceCommand

Object

Cihaz komut tanımı.

Name	Tür	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Bağlantısı kesilmiş bir cihazın çevrimiçi olmasını beklemek için saniyeler içinde bağlantı zaman aşımı. Varsayılan değer 0 saniyedir.
id	string	Cihaz komut yürütmesinin istek kimliği.
request		Cihaz komutunun yükü, tüm temel türleri veya nesneleri destekler.
response		Cihaz komut yanıtının yükü, tüm temel türleri veya nesneleri destekler.
responseCode	integer (int32)	Cihaz komut yanıtının durum kodu.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Bir cihazda komutun tamamlanmasını beklemek için saniye cinsinden yanıt zaman aşımı. Varsayılan değer 30 saniyedir.

Error

Object

Yanıt hatası tanımı.

Name	Tür	Description
error	ErrorDetails	Geçerli istek için hata ayrıntıları.

ErrorDetails

Object

Hatanın ayrıntılı bilgileri.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi ayrıntıları.
requestId	string	Geçerli istek için bağıntı kimliği.
time	string (date-time-rfc1123)	Hata isteğinin başarısız olduğu zaman.