全部產品
Search
文件中心

IoT Platform:ListThingTemplates

更新時間:Feb 13, 2025

調用該介面擷取物聯網平台預定義的標準產品品類列表。

使用說明

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

您調用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"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。