プロダクトの Thing Specification Language（TSL）モデルの機能をクエリします。
使用方法
TSL 機能には、プロパティ、サービス、イベントが含まれます。
プロダクトの TSL モデルにカスタムモジュールが追加されていて、リクエストで FunctionBlockId パラメーターを指定しない場合、この操作は各カスタムモジュールの TSL 機能を返します。FunctionBlockId パラメーターをリクエストで指定した場合、この操作は指定されたカスタムモジュールの TSL 機能を返します。
ThingModelJson レスポンスパラメーターのデータ形式の詳細については、「ThingModelJson のデータ構造」をご参照ください。
QPS 制限
この API 操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。
Alibaba Cloud アカウントの Resource Access Management（RAM）ユーザーは、アカウントのクォータを共有します。
デバッグ
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
Action | String | はい | QueryThingModel | 実行する操作。値を QueryThingModel に設定します。 |
IotInstanceId | String | いいえ | iot_instc_pu****_c*-v64******** | インスタンス ID。インスタンス ID は、IoT Platform コンソールの [概要] タブで確認できます。 重要
インスタンスの詳細については、「概要」をご参照ください。 |
ResourceGroupId | String | いいえ | rg-acfm4l5tcwd**** | リソースグループ ID。 重要 IoT Platform は、インスタンスごとのみリソースグループ管理をサポートしています。 ResourceGroupId パラメーターは無効です。このパラメーターを指定する必要はありません。 |
ProductKey | String | いいえ | a1BwAGV**** | プロダクトの ProductKey。 |
ModelVersion | String | いいえ | v1.0.0 | TSL モデルのバージョン番号。 ListThingModelVersion 操作を呼び出して、プロダクトの TSL モデルのバージョン番号を表示できます。 このパラメーターを指定しない場合、ドラフト状態の TSL モデルがクエリされます。このパラメーターを指定すると、指定したバージョンの TSL モデルがクエリされます。 |
FunctionBlockId | String | いいえ | BatteryModule | カスタム TSL モジュールの識別子。各識別子はプロダクト内で一意です。 このパラメーターを指定しない場合、デフォルトモジュールがクエリされます。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
パラメーター | タイプ | 例 | 説明 |
Code | String | iot.system.SystemException | リクエストが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
Data | Struct | リクエストが成功した場合に返されるデータ。 | |
ThingModelJson | String | { "productKey":"a1Jw4id***", "_ppk":{ "version":"1.1", "description":"xxx" }, "properties":[ { "identifier": "SimCardType", "dataSpecs": { "max": "1", "dataType": "INT", "unit": "mmHg", "min": "0", "step": "1" }, "std": false, "custom": true, "dataType": "INT", "rwFlag": "READ_ONLY", "productKey": "a1Jw4idFWHX", "required": false, "customFlag": true, "name": "SIM card type" } ], "services":[], "events":[] } | TSL モデルの機能。デフォルトモジュールの TSL データ形式は、カスタムモジュールの TSL データ形式とは異なります。 ThingModelJson パラメーターのデータ形式の詳細については、「ThingModelJson のデータ構造」をご参照ください。 |
ErrorMessage | String | システム例外が発生しました。 | リクエストが失敗した場合に返されるエラーメッセージ。 |
ProductKey | String | a1BwAGV**** | プロダクトの ProductKey。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | リクエスト ID。 |
Success | Boolean | true | リクエストが成功したかどうかを示します。有効な値：
|
例
リクエストの例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModel
&ProductKey=a1bPo9p****
&ModelVersion=v1.0.0
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<QueryThingModelResponse>
<RequestId>1F9041A2-ED5B-4A5A-9C44-598E28C0B434</RequestId>
<Data>
<ThingModelJson>{"_ppk":{"version":"1594253010934"},"events":[],"productKey":"a114xeJ****","properties":[{"configCode":"8C03F0EEC63D4897BF2637F89AE36B011594227294067","custom":true,"customFlag":true,"dataSpecs":{"custom":true,"dataType":"INT","max":"1","min":"0","step":"1","unit":"ppb"},"dataType":"INT","description":"1","extendConfig":"{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}","identifier":"WakeUpData","name":"Wakeup_Data","productKey":"a114xeJGj2p","required":false,"rwFlag":"READ_ONLY","std":false}],"services":[]}</ThingModelJson>
</Data>
<Success>true</Success>
</QueryThingModelResponse>JSON 形式
{
"RequestId": "1F9041A2-ED5B-4A5A-9C44-598E28C0B434",
"Data": {
"ThingModelJson": "{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a114xeJ****\",\"properties\":[{\"configCode\":\"8C03F0EEC63D4897BF2637F89AE36B011594227294067\",\"custom\":true,\"customFlag\":true,\"dataSpecs\":{\"custom\":true,\"dataType\":\"INT\",\"max\":\"1\",\"min\":\"0\",\"step\":\"1\",\"unit\":\"ppb\"},\"dataType\":\"INT\",\"description\":\"1\",\"extendConfig\":\"{\\\"originalDataType\\\":{\\\"specs\\\":{\\\"registerCount\\\":1,\\\"reverseRegister\\\":0,\\\"swap16\\\":0},\\\"type\\\":\\\"bool\\\"},\\\"identifier\\\":\\\"WakeUpData\\\",\\\"registerAddress\\\":\\\"0x04\\\",\\\"scaling\\\":1,\\\"writeFunctionCode\\\":0,\\\"operateType\\\":\\\"inputStatus\\\",\\\"pollingTime\\\":1000,\\\"trigger\\\":1}\",\"identifier\":\"WakeUpData\",\"name\":\"Wakeup_Data\",\"productKey\":\"a114xeJGj2p\",\"required\":false,\"rwFlag\":\"READ_ONLY\",\"std\":false}],\"services\":[]}"
},
"Code": "",
"Success": true
}エラーコード
エラーコードのリストについては、「サービスエラーコード」をご参照ください。