Devices - Run Command

Servicio:

IoT Central

Versión de la API:

2022-07-31

Ejecución de un comando de dispositivo
Ejecute un comando en un dispositivo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
baseDomain	path	True	string	Dominio base para todas las solicitudes de servicio de Azure IoT Central.
commandName	path	True	string	Nombre de este comando de dispositivo.
deviceId	path	True	string	Identificador único del dispositivo.
subdomain	path	True	string	Subdominio de aplicación.
api-version	query	True	string	Versión de la API a la que se llama.

Cuerpo de la solicitud

Nombre	Tipo	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Tiempo de espera de conexión en segundos para esperar a que un dispositivo desconectado se conecte. El valor predeterminado es 0 segundos.
request		La carga del comando del dispositivo, admite cualquier tipo primitivo o objeto.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Tiempo de espera de respuesta en segundos para esperar la finalización de un comando en un dispositivo. El valor predeterminado es de 30 segundos.

Respuestas

Nombre	Tipo	Description
201 Created	DeviceCommand	Éxito
Other Status Codes	Error	Respuesta de error recibida del servicio IoT Central. Encabezados x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Send command

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

status code:

201

{}

Definiciones

Nombre	Description
DeviceCommand	Definición del comando de dispositivo.
Error	Definición de error de respuesta.
ErrorDetails	Información detallada del error.

DeviceCommand

Object

Definición del comando de dispositivo.

Nombre	Tipo	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Tiempo de espera de conexión en segundos para esperar a que un dispositivo desconectado se conecte. El valor predeterminado es 0 segundos.
id	string	Identificador de solicitud de la ejecución del comando del dispositivo.
request		La carga del comando del dispositivo, admite cualquier tipo primitivo o objeto.
response		La carga de la respuesta del comando del dispositivo, admite cualquier tipo primitivo o objeto.
responseCode	integer (int32)	Código de estado de la respuesta del comando del dispositivo.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Tiempo de espera de respuesta en segundos para esperar la finalización de un comando en un dispositivo. El valor predeterminado es de 30 segundos.

Error

Object

Definición de error de respuesta.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error de la solicitud actual.

ErrorDetails

Object

Información detallada del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Detalles del mensaje de error.
requestId	string	Id. de correlación para la solicitud actual.
time	string (date-time-rfc1123)	Hora en que se produjo un error en la solicitud de error.