Creates tags for a product.

Usage notes

  • You can create a maximum of 10 tags for a product in a single call.
  • Each product can have a maximum of 100 tags.
Important You must specify the tag keys and tag values. Otherwise, the call fails. For description about the tag values, see the "Request parameters" section of this topic.

QPS limits

Each Alibaba Cloud account can run a maximum of 500 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 CreateProductTags

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

ProductKey String Yes a1BwAGV****

The ProductKey of the product. A ProductKey is a GUID that is issued by IoT Platform to a product.

You can use the IoT Platform console or call the QueryProductList operation to view the information about all products within the current account.

IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console.

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

For more information, see Overview.

ProductTag.N.TagKey String No room

The keys of product tags. Each key must be 1 to 30 characters in length, and can contain letters, digits, and periods (.).

Important abc is a key that is reserved by IoT Platform. You cannot set a key to abc. If you set a key to abc, the key is automatically filtered when you query tags.
ProductTag.N.TagValue String No TagValue

The values of the product tags. Each tag value must be 1 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-).

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this 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 request fails.

InvalidProductTags Array of ProductTag

The invalid product tags returned if the call fails.

ProductTag
TagKey String room

The key of the 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 was successful.

  • true: The call was successful. The tags were attached to the product.
  • false: The call failed. This value indicates that the tags failed to be attached to the product.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTags
&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 

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

JSON format 

{
  "RequestId": "354A4F9B-6B01-4498-8084-867F59720BA5",
  "Success": true
}

Error codes

For a list of error codes, see Service error codes.