Queries the topic categories of a specified product.

Limits

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

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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 QueryProductTopic

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

ProductKey String Yes HMyB*******

The ProductKey of the product.

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 ProductTopicInfo

The list of topic categories returned if the call is successful. For more information, see ProductTopicInfo.

ProductTopicInfo
Desc String topicDesc

The description of the topic category.

Id String 821****

The ID of the topic category.

Operation String 1

The operation that devices can perform on the topic category. Valid values:

  • 0: Publish.
  • 1: Subscribe.
  • 2: Publish and Subscribe.
ProductKey String HMyB***

The ProductKey of the product.

TopicShortName String /HMyB***/${deviceName}/user/get

The topic category that does not include the _productKey_ and _deviceName_ levels.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD

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=QueryProductTopic
&ProductKey=HMyB*******
&<Common request parameters>

Sample success responses

XML format 

<QueryProductTopicResponse>
  <RequestId>22C22D81-11EA-419F-81F1-08207DD9D0E5</RequestId>
  <Data>
        <ProductTopicInfo>
              <TopicShortName>/g18***/${deviceName}/user/update</TopicShortName>
              <Operation>0</Operation>
              <Id>12362218</Id>
              <ProductKey>g18***</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18***/${deviceName}/user/update/error</TopicShortName>
              <Operation>0</Operation>
              <Id>12362219</Id>
              <ProductKey>g18***</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18***/${deviceName}/user/get</TopicShortName>
              <Operation>1</Operation>
              <Id>12362220</Id>
              <ProductKey>g18***</ProductKey>
        </ProductTopicInfo>
  </Data>
  <Success>true</Success>
</QueryProductTopicResponse>

JSON format 

{
    "RequestId": "22C22D81-11EA-419F-81F1-08207DD9D0E5",
    "Data": {
        "ProductTopicInfo": [
            {
                "TopicShortName": "/g18***/${deviceName}/user/update",
                "Operation": "0",
                "Id": "12362218",
                "ProductKey": "g18***"
            },
            {
                "TopicShortName": "/g18***/${deviceName}/user/update/error",
                "Operation": "0",
                "Id": "12362219",
                "ProductKey": "g18***"
            },
            {
                "TopicShortName": "/g18***/${deviceName}/user/get",
                "Operation": "1",
                "Id": "12362220",
                "ProductKey": "g18***"
            }
        ]
    },
    "Success": true
}

Error codes

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