调用该接口为指定设备设置标签。

使用说明

  • 单个设备的设备标签总数不超过100个。
  • 单次修改或新增的设备标签数不超过100个。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SaveDeviceProp

系统规定参数。取值：SaveDeviceProp。
Props String 是 {"color":"red"}

要设置的设备标签，支持设置多个标签。

设备标签是JSON格式，每个标签的具体结构为：Key:Value。Key是标签名称，Value是对应的标签值。

多个标签使用半角逗号隔开，例如Props={"color":"red","shape":"round"}。

重要
  • Props的总大小不超过5 KB。
  • abc为物联网平台系统保留的标签Key，即标签Key不能设置为abc。若设置Key=abc，使用标签检索时会直接被过滤。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

ProductKey String 否 a1BwAGV****

设备所属的产品ProductKey。

说明 如果传入该参数，需同时传入DeviceName。
DeviceName String 否 light

设备名称。

说明 如果传入该参数，需同时传入ProductKey。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。

说明 如果传入该参数，则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符，和ProductKey与DeviceName组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName组合，则以IotId为准。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=SaveDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&Props=%7B%22color%22%3A%22red%22%7D
&<公共请求参数>

正常返回示例

XML格式 

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

JSON格式 

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