Devices - Get Command History

Szolgáltatás:

IoT Central

API-verzió:

2022-07-31

Eszközparancsok előzményeinek lekérése

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
baseDomain	path	True	string	Az Azure IoT Central szolgáltatáskéréseinek alaptartománya.
commandName	path	True	string	Az eszközparancs neve.
deviceId	path	True	string	Az eszköz egyedi azonosítója.
subdomain	path	True	string	Az alkalmazás altartománya.
api-version	query	True	string	A meghívott API verziója.

Válaszok

Name	Típus	Description
200 OK	DeviceCommandCollection	Siker
Other Status Codes	Error	Hibaválasz érkezett az IoT Central szolgáltatástól. Fejlécek x-ms-error-code: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get command history

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "request": 20,
      "id": "4e17dd2e-7bf2-458d-8466-19bc6fc9b642",
      "response": 58.795679629034694,
      "responseCode": 200
    }
  ]
}

Definíciók

Name	Description
DeviceCommand	Az eszköz parancsdefiníciója.
DeviceCommandCollection	Az eszközparancsok végrehajtásának lapozott eredményei.
Error	A válaszhiba definíciója.
ErrorDetails	A hiba részletes információi.

DeviceCommand

Objektum

Az eszköz parancsdefiníciója.

Name	Típus	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	A kapcsolat időtúllépése másodpercben, amíg egy leválasztott eszköz online állapotba kerül. Alapértelmezés szerint 0 másodperc.
id	string	Az eszközparancs végrehajtásának kérésazonosítója.
request		Az eszközparancs hasznos adatai támogatnak minden primitív típust vagy objektumot.
response		Az eszközparancs-válasz hasznos adatai támogatnak minden primitív típust vagy objektumot.
responseCode	integer (int32)	Az eszközparancs-válasz állapotkódja.
responseTimeout	integer (int32) minimum: 5 maximum: 30	A válasz időtúllépése másodpercekben, hogy megvárja a parancsok befejezését egy eszközön. Alapértelmezés szerint 30 másodperc.

DeviceCommandCollection

Objektum

Az eszközparancsok végrehajtásának lapozott eredményei.

Name	Típus	Description
nextLink	string	URL-cím az eszközparancsok végrehajtásának következő oldalához.
value	DeviceCommand[]	Az eszközparancsok végrehajtásának gyűjteménye.

Error

Objektum

A válaszhiba definíciója.

Name	Típus	Description
error	ErrorDetails	Az aktuális kérés hibaadatai.

ErrorDetails

Objektum

A hiba részletes információi.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet részletei.
requestId	string	Az aktuális kérés korrelációs azonosítója.
time	string (date-time-rfc1123)	A hibakérés sikertelen volt.