QueryThingModelPublished API で公開済み TSL モデルを查询 - IoT Platform

プロダクトの公開されている Thing Specification Language (TSL) モデルをクエリします。

QPS 制限

この操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。

説明

Alibaba Cloud アカウントの Resource Access Management (RAM) ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryThingModelPublished	実行する操作。値を QueryThingModelPublished に設定します。
ProductKey	String	はい	a1BwAGV****	プロダクトの ProductKey。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンス ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを指定する必要があります。指定しないと、リクエストは失敗します。 IoT Platform コンソールに概要ページまたはインスタンス ID が表示されない場合は、このパラメーターを指定する必要はありません。詳細については、「概要」をご参照ください。
ResourceGroupId	String	いいえ	rg-acfm4l5tcwd***	リソースグループ ID。重要 IoT Platform は、インスタンスごとのみリソース管理をサポートしています。このリクエストでは、ResourceGroupId は有効になりません。このパラメーターを指定する必要はありません。
ModelVersion	String	いいえ	v1.0.0	TSL モデルのバージョン番号。 ListThingModelVersion 操作を呼び出して、プロダクトの TSL モデルのバージョン番号を確認できます。このパラメーターを指定しない場合は、公開されている TSL モデルの最後のバージョンが返されます。
FunctionBlockId	String	いいえ	BatteryModule	カスタム TSL モジュールの識別子。各識別子は、プロダクト内で一意です。このパラメーターを指定しない場合は、デフォルトのモジュールがクエリされます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	リクエストが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		レスポンスパラメーター。
ThingModelJson	String	{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a1BwAGV**\",\"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\":\"a114xeJ**\",\"required\":false,\"rwFlag\":\"READ_ONLY\",\"std\":false}],\"services\":[]}	TSL モデルに定義されている機能。 ThingModelJson のデータ形式の詳細については、「ThingModelJson のデータ構造」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	リクエストが失敗した場合に返されるエラーメッセージ。
ProductKey	String	a1BwAGV****	プロダクトの ProductKey。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエスト ID。
Success	Boolean	true	リクエストが成功したかどうかを示します。有効な値： true false

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModelPublished
&ProductKey=a1BwAGV****
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryThingModelPublishedResponse>
    <RequestId>1F9041A2-ED5B-4A5A-9C44-598E28C0B434</RequestId>
    <Data>
        <ThingModelJson>{"_ppk":{"version":"1594253010934"},"events":[],"productKey":"a1BwAGV****","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":"a114xeJ****","required":false,"rwFlag":"READ_ONLY","std":false}],"services":[]}</ThingModelJson>
    </Data>
    <Success>true</Success>
</QueryThingModelPublishedResponse>

JSON 形式

{
   "RequestId": "1F9041A2-ED5B-4A5A-9C44-598E28C0B434",
   "Data": {
      "ThingModelJson": "{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a1BwAGV****\",\"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\":[]}"
   },
   "Success": true
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。