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

Establece una etiqueta para un dispositivo.

Notas de uso

Un dispositivo admite un máximo de 100 etiquetas.
Puede modificar o agregar hasta 100 etiquetas a la vez.

Límites de QPS

Cada cuenta de Alibaba Cloud puede ejecutar hasta 50 consultas por segundo (QPS).

Nota

Los usuarios de Resource Access Management (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 llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	SaveDeviceProp	La operación que desea ejecutar. Establezca el valor en SaveDeviceProp.
Props	String	Sí	{"color":"red"}	La etiqueta que desea especificar para el dispositivo. Puede definir varias etiquetas. Las etiquetas deben ser datos JSON con el formato Key:Value. Key indica el nombre de la etiqueta y Value indica su valor. Separe varias etiquetas con comas (,). Ejemplo: Props={"color":"red","shape":"round"} Importante El tamaño máximo del parámetro Props es de 5 KB. `abc` es una clave reservada por IoT Platform. No establezca Key como abc. Si configura `Key` como abc, la etiqueta abc se filtra automáticamente al consultar las etiquetas.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. En la página Overview de la consola de IoT Platform, consulte el ID de la instancia. Importante Si su instancia tiene un ID, especifíquelo en este parámetro. De lo contrario, la llamada fallará. Si la página Overview o el ID de la instancia no se muestran en la consola de IoT Platform, no configure este parámetro. Para obtener más información sobre la instancia, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Es un identificador único emitido por IoT Platform para el dispositivo. Nota Si especifica este parámetro, no necesita especificar los parámetros ProductKey ni DeviceName. El parámetro IotId define un identificador único global (GUID) para el dispositivo. El valor del parámetro IotId corresponde a una combinación de los valores de los parámetros ProductKey y DeviceName. Si especifica los parámetros IotId, ProductKey y DeviceName, el valor del parámetro IotId tendrá prioridad.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, especifique los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información sobre los códigos de error, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=SaveDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&Props=%7B%22color%22%3A%22red%22%7D
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<SaveDevicePropResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
</SaveDevicePropResponse>

Formato JSON

{
    "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
    "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.