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

プロダクトの公開済みの Thing Specification Language (TSL) モデルを照会します。

QPS 制限

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

説明

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	GetThingModelTslPublished	実行する操作。値を GetThingModelTslPublished に設定します。
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 は有効になりません。このパラメーターを指定する必要はありません。
Simple	Boolean	いいえ	true	簡略化された TSL モデルを返すかどうかを指定します。有効な値： true: 簡略化された TSL モデルを返します。簡略化された TSL モデルは、デバイスのプロパティ、サービス、イベント、および入力パラメーターと出力パラメーターの識別子とデータ型のみ定義します。簡略化された TSL モデルは、デバイス開発者が参考のために使用できます。 false (デフォルト): 完全な TSL モデルを返します。完全な TSL モデルは、デバイスのプロパティ、サービス、イベント、およびすべてのパラメーターと値を定義します。完全な TSL モデルは、クラウドアプリケーション開発者が参考のために使用できます。
ModelVersion	String	いいえ	v1.0.0	TSL モデルのバージョン番号。 ListThingModelVersion 操作を呼び出して、プロダクトの TSL モデルのバージョン番号を照会できます。このパラメーターを指定しない場合は、最後に公開された TSL モデルバージョンが使用されます。
FunctionBlockId	String	いいえ	BatteryModule	カスタム TSL モジュールの識別子。各識別子はプロダクト内で一意です。このパラメーターを指定しない場合は、デフォルトモジュールが使用されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	リクエストが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		返されるデータ。
TslStr	String	{\"schema\":\"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json\",\"profile\":{\"productKey\":\"a14TeWI****\"},\"properties\":[{\"identifier\":\"Humidity\"}]}	TSL モデルの文字列。
TslUri	String	https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14T****/model.json?Expires=1581947119&OSSAccessKeyId=LTAI************&Signature=5i38****	Object Storage Service (OSS) に保存されている TSL データの Uniform Resource Identifier (URI)。 URI の有効期間は 60 分です。
ErrorMessage	String	システム例外が発生しました。	リクエストが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエスト ID。
Success	Boolean	true	リクエストが成功したかどうかを示します。有効な値： true false

例

リクエストの例

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

成功レスポンスの例

XML 形式

<GetThingModelTslPublishedResponse>
    <Data>
            <TslUri>https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14T******/model.json?Expires=1581947119&OSSAccessKeyId=LTAI****************&Signature=5i38******</TslUri>
            <TslStr>{"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14TeWI****"},"properties":[{"identifier":"Humidity","name":"Humidity","accessMode":"rw","required":false,"dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","accessMode":"rw","required":false,"dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}],"events":[{"identifier":"post","name":"post","type":"info","required":true,"desc":"Submit properties","method":"thing.event.property.post","outputData":[{"identifier":"Humidity","name":"Humidity","dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}]}],"services":[{"identifier":"set","name":"set","required":true,"callType":"async","desc":"Set properties","method":"thing.service.property.set","inputData":[{"identifier":"Humidity","name":"Humidity","dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}],\"outputData\":[]},{"identifier":"get","name":"get","required":true,"callType":"async","desc":"Query properties","method":"thing.service.property.get","inputData":["Humidity","Temperature"],"outputData":[{"identifier":"Humidity","name":"Humidity","dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}]}]}</TslStr>
    </Data>
    <RequestId>C4371E68-F6DB-4D7B-8AD0-D38336E1DF94</RequestId>
    <Success>true</Success>
</GetThingModelTslPublishedResponse>

JSON 形式

{
    "Data": {
        "TslUri": "https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14T******/model.json?Expires=1581947119&OSSAccessKeyId=LTAI****************&Signature=5i38******",
        "TslStr": "{\"schema\":\"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json\",\"profile\":{\"productKey\":\"a14TeWI****\"},\"properties\":[{\"identifier\":\"Humidity\",\"name\":\"Humidity\",\"accessMode\":\"rw\",\"required\":false,\"dataType\":{\"type\":\"int\",\"specs\":{\"min\":\"55\",\"max\":\"60\",\"unit\":\"%\",\"step\":\"1\"}}},{\"identifier\":\"Temperature\",\"name\":\"Temperature\",\"accessMode\":\"rw\",\"required\":false,\"dataType\":{\"type\":\"float\",\"specs\":{\"min\":\"26\",\"max\":\"28\",\"unit\":\"°C\",\"step\":\"0.01\"}}}],\"events\":[{\"identifier\":\"post\",\"name\":\"post\",\"type\":\"info\",\"required\":true,\"desc\":\"Submit properties\",\"method\":\"thing.event.property.post\",\"outputData\":[{\"identifier\":\"Humidity\",\"name\":\"Humidity\",\"dataType\":{\"type\":\"int\",\"specs\":{\"min\":\"55\",\"max\":\"60\",\"unit\":\"%\",\"step\":\"1\"}}},{\"identifier\":\"Temperature\",\"name\":\"Temperature\",\"dataType\":{\"type\":\"float\",\"specs\":{\"min\":\"26\",\"max\":\"28\",\"unit\":\"°C\",\"step\":\"0.01\"}}}]}],\"services\":[{\"identifier\":\"set\",\"name\":\"set\",\"required\":true,\"callType\":\"async\",\"desc\":\"Set properties\",\"method\":\"thing.service.property.set\",\"inputData\":[{\"identifier\":\"Humidity\",\"name\":\"Humidity\",\"dataType\":{\"type\":\"int\",\"specs\":{\"min\":\"55\",\"max\":\"60\",\"unit\":\"%\",\"step\":\"1\"}}},{\"identifier\":\"Temperature\",\"name\":\"Temperature\",\"dataType\":{\"type\":\"float\",\"specs\":{\"min\":\"26\",\"max\":\"28\",\"unit\":\"°C\",\"step\":\"0.01\"}}}],\"outputData\":[]},{\"identifier\":\"get\",\"name\":\"get\",\"required\":true,\"callType\":\"async\",\"desc\":\"Query properties\",\"method\":\"thing.service.property.get\",\"inputData\":[\"Humidity\",\"Temperature\"],\"outputData\":[{\"identifier\":\"Humidity\",\"name\":\"Humidity\",\"dataType\":{\"type\":\"int\",\"specs\":{\"min\":\"55\",\"max\":\"60\",\"unit\":\"%\",\"step\":\"1\"}}},{\"identifier\":\"Temperature\",\"name\":\"Temperature\",\"dataType\":{\"type\":\"float\",\"specs\":{\"min\":\"26\",\"max\":\"28\",\"unit\":\"°C\",\"step\":\"0.01\"}}}]}]}"
    },
    "RequestId": "C4371E68-F6DB-4D7B-8AD0-D38336E1DF94",
    "Success": true
}

エラーコード

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