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).

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 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. 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 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.

  • true: The call was successful.
  • false: The call failed.

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 Rearview Mirror",
      "CategoryKey": "SmartRearviewMirror"
    },
    {
      "CategoryName": "Smart In-vehicle Infotainment",
      "CategoryKey": "SmartTox"
    }
  ]
}

Error codes

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