調用該接口獲取物聯網平臺預定義的標準產品品類列表。

使用說明

物聯網平臺提供已定義了物模型的產品品類供您使用,例如路燈照明、車輛定位卡、水浸檢測等。

您調用CreateProduct接口創建產品時,可以傳入參數CategoryKey指定品類,創建的產品將引用該品類的標準物模型。

QPS限制

單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為5。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String ListThingTemplates

系統規定參數。取值:ListThingTemplates。

IotInstanceId String iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID

注意
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無ID值,則無需傳入。

實例的更多信息,請參見實例概述

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼

Data Array of CategoryInfo

調用成功時,返回的標準品類列表。

CategoryKey String lighting

品類的標識符。

CategoryName String 路燈照明

品類的名稱。

ErrorMessage String 系統異常

調用失敗時,返回的出錯信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請求生成的唯一標識符。

Success Boolean true

表示是否調用成功。

  • true:調用成功。
  • false:調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListThingTemplates
&<公共請求參數>

正常返回示例

XML格式

<ListThingTemplatesResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <CategoryName>智能后視鏡</CategoryName>
        <CategoryKey>SmartRearviewMirror</CategoryKey>
  </Data>
  <Data>
        <CategoryName>智能車機</CategoryName>
        <CategoryKey>SmartTox</CategoryKey>
  </Data>
</ListThingTemplatesResponse>

JSON格式

{
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success":true,
  "Data": [
    {
      "CategoryName": "智能后視鏡",
      "CategoryKey": "SmartRearviewMirror"
    },
    {
      "CategoryName": "智能車機",
      "CategoryKey": "SmartTox"
    }
  ]
}