Specifies a tag for a device.

Usage notes

  • A device can have a maximum of 100 tags.
  • You can modify or add a maximum of 100 tags at a time.

QPS limits

Each Alibaba Cloud account can run up to 50 queries per second (QPS).

Note The Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SaveDeviceProp

The operation that you want to perform. Set the value to SaveDeviceProp.

Props String Yes {"color":"red"}

The tag that you want to specify for the device. You can specify multiple tags.

The tags must be JSON data in the Key:Value format. Key indicates the tag name, and Value indicates the tag value.

Separate multiple tags with commas (,). Example: Props={"color":"red","shape":"round"}

Important
  • The maximum size of the Props parameter is 5 KB.
  • abc is a key that is reserved by IoT Platform. You cannot set Key to abc. If you set Key to abc, the abc tag is automatically filtered when you query tags.
IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. On the Overview page in the IoT Platform console, you can view the ID of the instance.

Important
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If the Overview page or instance ID is not displayed in the IoT Platform console, you do not need to configure this parameter.

For more information about the instance, see Overview.

ProductKey String No a1BwAGV****

The ProductKey of the product to which the device belongs.

Note If you specify this parameter, you must also specify the DeviceName parameter.
DeviceName String No light

The DeviceName of the device.

Note If you specify this parameter, you must also specify the ProductKey parameter.
IotId String No Q7uOhVRdZRRlDnTLv****00100

The ID of the device. The ID is a unique identifier that is issued by IoT Platform to the device.

Note If you specify this parameter, you do not need to specify the ProductKey or DeviceName parameters. The IotId parameter specifies a globally unique identifier (GUID) for the device. The value of the IotId parameter corresponds to a combination of the values of the ProductKey and DeviceName parameters. If you specify the IotId, ProductKey, and DeviceName parameters, the value of the IotId parameter takes precedence.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information about error codes, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

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

Sample success responses

XML format 

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

JSON format 

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