Specifies a tag for a device.

Limits

Each Alibaba Cloud account can run a maximum of 50 queries per second (QPS).

Note 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 of the device. Each device tag is in the Key:Value format.

Each device tag is in the JSON format and the Props parameter is a string, for example, Props={"color":"red"}.

Note The maximum size of the Props string is 5 KB.

Each device can have a maximum of 100 tags.

You can modify or add a maximum of 100 tags at a time.
IotInstanceId String No iot_instc_pu****_c*-v64********

The instance ID. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

IotId String No Q7uOhVRdZRRlDnTLv****00100

The ID of the device. The ID is the 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 parameter. The IotId parameter specifies a unique identifier for the device, and corresponds to a combination of the ProductKey and DeviceName parameters. If you specify the IotId parameter and a combination of the ProductKey and DeviceName parameters at the same time, the IotId parameter takes precedence.
DeviceName String No light

The name of the device.

Note If you specify this parameter, you must also specify the ProductKey parameter.
ProductKey String No a1BwAGV****

The key of the product to which the device belongs.

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

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

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, 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 succeeds.

  • true: The call succeeded.
  • 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
}

Error codes

For a list of error codes, visit the API Error Center.