Queries standard product categories that are predefined by IoT Platform.
Usage notes
IoT Platform provides product categories that have defined TSL models, such as street lamps, vehicle location cards, and water immersion detectors.
When you call the CreateProduct operation to create a product, you can set the CategoryKey parameter to specify a product category. The product that you create references the standardized TSL model of the specified category.
Limits
Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListThingTemplates |
The operation that you want to perform. Set the value to ListThingTemplates. |
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. |
ResourceGroupId | String | No | rg-acfm4l5tcwd**** |
The ID of the resource group. Note You cannot specify this parameter.
|
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For information about common request parameters, see Common 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 CategoryInfo |
The list of standard categories returned if the call is successful. |
|
CategoryKey | String | lighting |
The identifier of the category. |
CategoryName | String | Street Lamp |
The name of the category. |
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.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=ListThingTemplates
&<Common request parameters>
Sample success responses
XML
format
<ListThingTemplatesResponse>
<RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
<Success>true</Success>
<Data>
<CategoryName>Smart Rear-view Mirror</CategoryName>
<CategoryKey>SmartRearviewMirror</CategoryKey>
</Data>
<Data>
<CategoryName>Smart In-vehicle Infotainment</CategoryName>
<CategoryKey>SmartTox</CategoryKey>
</Data>
</ListThingTemplatesResponse>
JSON
format
{
"RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
"Success":true,
"Data": [
{
"CategoryName": "Smart Rear-view Mirror",
"CategoryKey": "SmartRearviewMirror"
},
{
"CategoryName": "Smart In-vehicle Infotainment",
"CategoryKey": "SmartTox"
}
]
}
Error codes
For a list of error codes, visit the API Error Center.