ListThingTemplates - IoT Platform - Alibaba Cloud ドキュメントセンター

IoT Platform によって事前定義されている標準プロダクトカテゴリをクエリします。

使用方法

IoT Platform は、街灯、車両位置カード、水没検知器など、TSL モデルが定義されたプロダクトカテゴリを提供します。

CreateProduct 操作を呼び出してプロダクトを作成する際に、CategoryKey パラメーターを設定してプロダクトカテゴリを指定できます。作成するプロダクトは、指定されたカテゴリの標準化された TSL モデルを参照します。

制限

Alibaba Cloud アカウントごとに、最大 5 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。 OpenAPI Explorer は署名の値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター

タイプ

必須

例

説明

Action

String

はい

ListThingTemplates

実行する操作。値を ListThingTemplates に設定します。

IotInstanceId

String

いいえ

iot_instc_pu****_c*-v64********

インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。

重要

インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。
インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。

詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通リクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	CategoryInfo の配列		呼び出しが成功した場合に返される標準カテゴリのリスト。
CategoryKey	String	lighting	カテゴリの識別子。
CategoryName	String	Street Lamp	カテゴリの名前。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	ブール値	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>Smart Rear-view Mirror</CategoryName>
        <CategoryKey>SmartRearviewMirror</CategoryKey>
  </Data>
  <Data>
        <CategoryName>Smart In-vehicle Infotainment</CategoryName>
        <CategoryKey>SmartTox</CategoryKey>
  </Data>
</ListThingTemplatesResponse>

JSON 形式

{
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success":true,
  "Data": [
    {
      "CategoryName": "Smart Rearview Mirror",
      "CategoryKey": "SmartRearviewMirror"
    },
    {
      "CategoryName": "Smart In-vehicle Infotainment",
      "CategoryKey": "SmartTox"
    }
  ]
}

エラーコード

エラーコードの一覧については、API エラーセンターをご覧ください。