GetDeviceShadow - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta la información de sombra (shadow) de un dispositivo específico.

Límites de QPS

Puede invocar esta API hasta 500 veces por segundo por cada cuenta.

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	No	GetDeviceShadow	Operación que desea ejecutar. Establezca el valor en GetDeviceShadow.
DeviceName	String	No	device1	El DeviceName del dispositivo.
ProductKey	String	No	a1T27vz****	El ProductKey del producto al que pertenece el dispositivo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si la instancia tiene un ID, especifique el parámetro IotInstanceId. De lo contrario, la llamada terminará con errores. Si la instancia no tiene un ID o no se muestra la página Overview, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.

Además de los parámetros de solicitud específicos de esta operación, debe especificar los parámetros de solicitud comunes al invocarla. Para obtener más información sobre estos parámetros, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	Código de error que se devuelve cuando la llamada termina con errores. Para obtener más información sobre los códigos de error, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	Mensaje de error que se devuelve cuando la llamada termina con errores.
RequestId	String	A56E345A-0978-4993-ACBA-3EF444ED187F	ID de la solicitud.
ShadowMessage	String	{"method":"update","state":{"desired":{"color":"green"}},"version":1}	Información de sombra que se devuelve cuando la llamada es exitosa. Nota La estructura de la información de sombra varía según el estado del dispositivo. Para obtener más información, consulte el tema Descripción general de sombras de dispositivos.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: la llamada fue exitosa. false: la llamada terminó con errores.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=GetDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&<Common request parameters>

Respuesta exitosa de ejemplo

Formato XML

<GetDeviceShadowResponse>
  <RequestId>A56E345A-0978-4993-ACBA-3EF444ED187F</RequestId>
  <ShadowMessage>{"method":"update","state":{"desired":{"color":"green"}},"version":1}</ShadowMessage>
  <Success>true</Success>
</GetDeviceShadowResponse>

Formato JSON

{
    "RequestId": "A56E345A-0978-4993-ACBA-3EF444ED187F",
    "ShadowMessage": "{\"method\":\"update\",\"state\":{\"desired\":{\"color\":\"green\"}},\"version\":1}",
    "Success": true
}

Códigos de error

Para consultar la lista de códigos de error, visite Códigos de error del servicio.