Updates product tags.
Limits
- You can update a maximum of 10 tags in a single call.
-
Each Alibaba Cloud account can run a maximum of 500 queries per second (QPS).Note Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateProductTags |
The operation that you want to perform. Set the value to UpdateProductTags. |
ProductKey | String | Yes | a1BwAGV**** |
The key of the product. A product key is a globally unique identifier (GUID) that is issued by IoT Platform to a new product. You can use the IoT Platform console or call the QueryProductList operation to query the details of all the products in the current account. |
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. |
ProductTag.N.TagValue | String | No | 202 |
The new values of product tags. Each value can contain letters, digits, underscores (_), and hyphens (-). The value must be 1 to 128 characters in length. |
ProductTag.N.TagKey | String | No | room |
The keys of the product tags. Each key must be 1 to 30 characters in length, and can contain letters, digits, and periods (.). Note Each tag key that you specify must already exist. Each tag value that you specify
must be unique.
|
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. |
InvalidProductTags | Array of ProductTag |
The details of invalid product tags returned if the call fails. The details are included in the ProductTag parameter. |
|
ProductTag | |||
TagKey | String | room |
The key of each tag. |
TagValue | String | 123 |
The value of the tag. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call succeeds.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateProductTags
&ProductKey=a1h7knJ****
&ProductTag.1.TagKey=first
&ProductTag.1.TagValue=value1
&ProductTag.2.TagKey=second
&ProductTag.2.TagValue=value2
&<Common request parameters>
Sample success responses
XML
format
<UpdateProductTagsResponse>
<RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
<Success>true</Success>
</UpdateProductTagsResponse>
JSON
format
{
"RequestId": "92586B4B-FF78-494A-A22C-368E4293FBB7",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.