Queries all the tags of a product.

Limits

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

Note 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 ListProductTags

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

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 instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

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.

Data Array of ProductTag

The product tags returned if the call succeeds. For more information, see the parameters that are included in the ProductTag parameter.

ProductTag
TagKey String room

The key of each tag.

TagValue String 102

The value of the tag.

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=ListProductTags
&ProductKey=a1h7knJ****
&<Common request parameters>

Sample success responses

XML format 

<ListProductTagsResponse>
      <Data>
            <ProductTag>
                  <TagValue>alterTable</TagValue>
                  <TagKey>binary</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>json2</TagValue>
                  <TagKey>extt</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>1234</TagValue>
                  <TagKey>Lock</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>support</TagValue>
                  <TagKey>Lockk</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>reen</TagValue>
                  <TagKey>Reen</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>try</TagValue>
                  <TagKey>Reenn</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>DropTable</TagValue>
                  <TagKey>roc</TagKey>
            </ProductTag>
      </Data>
      <RequestId>7FBE60F8-4AB5-4A8C-AFCB-F4F38851F01F</RequestId>
      <Success>true</Success>
</ListProductTagsResponse>

JSON format 

{
  "Data": {
    "ProductTag": [
      {
        "TagValue": "alterTable",
        "TagKey": "binary"
      },
      {
        "TagValue": "json2",
        "TagKey": "extt"
      },
      {
        "TagValue": "1234",
        "TagKey": "Lock"
      },
      {
        "TagValue": "support",
        "TagKey": "Lockk"
      },
      {
        "TagValue": "reen",
        "TagKey": "Reen"
      },
      {
        "TagValue": "try",
        "TagKey": "Reenn"
      },
      {
        "TagValue": "DropTable",
        "TagKey": "roc"
      }
    ]
  },
  "RequestId": "7FBE60F8-4AB5-4A8C-AFCB-F4F38851F01F",
  "Success": true
}

Error codes

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