Creates a custom topic category for a specified product.
Limits
Each Alibaba Cloud account can run only 1 query per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateProductTopic |
The operation that you want to perform. Set the value to CreateProductTopic. |
Operation | String | Yes | PUB |
The operation that devices can perform on the topic category. Valid values:
|
ProductKey | String | Yes | aldDEin**** |
The ProductKey of the product for which you want to create a topic category. |
TopicShortName | String | Yes | submit |
The custom level that is used in the topic category. By default, a topic category
includes the following levels: _productkey_ and _devicename_. Separate the two levels
with slashes (/). Format of a topic category: Note Each level can contain letters, digits, and underscores (_), and cannot be empty.
|
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased. |
Desc | String | No | submit a test topic |
The description of the topic category. The description must be 1 to 100 characters in length. |
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 call fails. |
RequestId | String | FCC27691-9151-4B93-9622-9C90F30542EC |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
TopicId | Long | 10000 |
The ID of the topic category. The ID is generated by IoT Platform if the call is successful. Note Store this parameter for future reference. When you call an operation that is related
to the topic category, you must provide this parameter.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTopic
&ProductKey=aldDEin****
&TopicShortName=submit
&Operation=PUB
&Desc=submit a test topic
&<Common request parameters>
Sample success responses
XML
format
<CreateProductTopicResponse>
<RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
<Success>true</Success>
<TopicId>10000</TopicId>
</CreateProductTopicResponse>
JSON
format
{
"RequestId":"FCC27691-9151-4B93-9622-9C90F30542EC",
"Success":true,
"TopicId":10000
}
Error codes
For a list of error codes, visit the API Error Center.