すべてのプロダクト
Search

このプロダクト

    IoT Platform:ImportThingModelTsl

    ドキュメントセンター

    IoT Platform:ImportThingModelTsl

    最終更新日:Apr 17, 2025

    プロダクトに Thing Specification Language（TSL）モデルをインポートします。

    使用方法

    CancelReleaseProduct 操作を呼び出す前に、ImportThingModelTsl 操作を呼び出す対象のプロダクトが公開済みの場合は、CancelReleaseProduct 操作を呼び出してプロダクトの公開を停止する必要があります。

    QPS 制限

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

    説明

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

    デバッグ

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

    リクエストパラメータ

    パラメータ

    タイプ

    必須

    例

    説明

    Action

    String

    はい

    ImportThingModelTsl

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

    ProductKey

    String

    はい

    a1BwAGV****

    プロダクトの ProductKey。

    ProductKey は、IoT Platform コンソールの [プロダクト] ページで確認できます。 また、QueryProductList 操作を呼び出して ProductKey をクエリすることもできます。

    IotInstanceId

    String

    いいえ

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

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

    重要

    • インスタンスに ID がある場合は、このパラメータを指定する必要があります。 指定しないと、リクエストは失敗します。

    • IoT Platform コンソールに 概要 タブまたはインスタンス ID が表示されない場合は、このパラメータを指定する必要はありません。

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

    ResourceGroupId

    String

    いいえ

    rg-acfm4l5tcwd****

    リソースグループ ID。

    重要

    IoT Platform は、インスタンスによるリソース管理のみをサポートしています。 ResourceGroupId パラメータは廃止されました。 このパラメータを指定する必要はありません。

    TslStr

    String

    いいえ

    {"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14TeW****"},"properties":[]}

    インポートする TSL モデル。 値は JSON 文字列です。 TSL モデルは、プロダクトのプロパティ、サービス、およびイベントを定義します。

    TslStr の値は、標準の TSL データ形式に準拠している必要があります。 詳細については、「TSL モデルとは」をご参照ください。

    説明

    TSL モデルをインポートするには、TslStr パラメータを指定する必要があります。

    TslUrl

    String

    いいえ

    https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14TeWI****/model.json?Expires=1581947119...

    Object Storage Service（OSS）に保存されている TSL モデルファイルの URI。

    説明

    このパラメータは有効ではありません。 TSL モデルをインポートするには、TslStr パラメータを指定する必要があります。

    FunctionBlockId

    String

    いいえ

    BatteryModule

    カスタム TSL モジュールの識別子。 各識別子は、プロダクト内で一意です。 識別子は 1 ～ 30 文字で、文字、数字、およびアンダースコア（_）を含めることができます。

    このパラメータは、FunctionBlockName と組み合わせて使用する必要があります。 このパラメータを指定しないと、システムはデフォルトモジュールをインポートします。

    FunctionBlockName

    String

    いいえ

    BatteryModule

    カスタム TSL モジュールの名前。 名前は 4 ～ 30 文字で、文字、数字、およびアンダースコア（_）を含めることができます。

    このパラメータは、FunctionBlockId と組み合わせて使用する必要があります。 このパラメータを指定しないと、システムはデフォルトモジュールをインポートします。

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

    レスポンスパラメータ

    パラメータ

    タイプ

    例

    説明

    Code

    String

    iot.system.SystemException

    リクエストが失敗した場合に返されるエラーコード。 詳細については、「エラーコード」をご参照ください。

    ErrorMessage

    String

    システム例外が発生しました。

    リクエストが失敗した場合に返されるエラーメッセージ。

    RequestId

    String

    E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

    リクエスト ID。

    Success

    Boolean

    true

    リクエストが成功したかどうかを示します。 有効な値：

    • true

    • false

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=ImportThingModelTsl
&ProductKey=a1lWSUw****
&TslStr={\"profile\":{\"productKey\": \"a1bPo9p****\"},\"services\":[],\"properties\":[],\"events\":[]}
&<共通リクエストパラメータ>

    成功レスポンスの例

    XML 形式

    <ImportThingModelTslResponse>
  <RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
  <Success>true</Success>
</ImportThingModelTslResponse>

    JSON 形式

    {
  "RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
  "Success": true
}

    エラーコード

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