すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:DeleteThingModel

最終更新日:Apr 17, 2025

1 つ以上の Thing Specification Language (TSL)機能をプロダクトから削除します。機能は、プロパティ、サービス、またはイベントです。

使用方法

  • プロダクトが公開されている場合は、DeleteThingModel 操作を呼び出す前に、CancelReleaseProduct 操作を呼び出してプロダクトの公開を停止する必要があります。

  • プロダクトの新しい機能またはカスタム TSL モジュールが公開されていない場合は、DeleteThingModel 操作を呼び出して、機能またはカスタム TSL モジュールを削除できます。

  • DeleteThingModel 操作を呼び出すときは、ProductKey パラメーターと、次のパラメーターの少なくとも 1 つを指定する必要があります。FunctionBlockIdPropertyIdentifier.NServiceIdentifier.NEventIdentifier.N。DeleteThingModel 操作の動作については、以下で説明します。

    • ProductKey パラメーターと FunctionBlockId パラメーターのみを指定した場合、操作は指定されたプロダクトから指定されたカスタム TSL モジュールを削除します。

    • ProductKey パラメーターと、PropertyIdentifier.NServiceIdentifier.N、または EventIdentifier.N パラメーターを指定した場合、操作は指定されたプロダクトのデフォルト TSL モジュールから 1 つ以上の指定された機能を削除します。操作は、指定された機能が存在する場合にのみ、それらの機能を削除します。PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N パラメーターで指定した機能 ID がデフォルトの TSL モジュールに存在しない場合、操作はエラーメッセージを返して、指定された機能が存在しないことを示します。

    • ProductKey パラメーターと FunctionBlockId パラメーター、および PropertyIdentifier.NServiceIdentifier.N、または EventIdentifier.N パラメーターを指定した場合、操作は指定されたプロダクトの指定されたカスタム TSL モジュールから 1 つ以上の指定された機能を削除します。操作は、指定された機能が存在する場合にのみ、それらの機能を削除します。PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N パラメーターで指定した機能 ID がカスタム TSL モジュールに存在しない場合、操作はエラーメッセージを返して、指定された機能が存在しないことを示します。

      説明

      PropertyIdentifier.NServiceIdentifier.N、または EventIdentifier.N パラメーターには、最大 10 個の機能 ID を指定できます。

  • DeleteThingModel 操作を呼び出してプロダクトから 1 つ以上の機能を削除した後、PublishThingModel 操作を呼び出して、プロダクトの TSL モデルを再公開する必要があります。これにより、変更が有効になります。

QPS 制限

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

説明

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

デバッグ

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

リクエストパラメーター

パラメーター

タイプ

必須

説明

Action

String

はい

DeleteThingModel

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

IotInstanceId

String

いいえ

iot-cn-0pp1n8t****

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

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

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

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

FunctionBlockId

String

いいえ

BatteryModule

カスタム TSL モジュールの ID。各 ID はプロダクト内で一意です。

  • PropertyIdentifier.NServiceIdentifier.N、または EventIdentifier.N パラメーターが指定されているときに FunctionBlockId パラメーターを指定すると、操作は指定されたカスタム TSL モジュールから 1 つ以上の指定された機能を削除します。FunctionBlockId パラメーターを指定しないと、操作はデフォルトの TSL モジュールから 1 つ以上の指定された機能を削除します。

  • PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N パラメーターが指定されていないときに FunctionBlockId パラメーターを指定すると、操作は指定されたカスタム TSL モジュールと、指定されたカスタム TSL モジュール内のすべての機能を削除します。

ProductKey

String

いいえ

a1BwAGV****

プロダクトの ProductKey

PropertyIdentifier.N

RepeatList

いいえ

Temperature

削除するプロパティの ID。最大 10 個のプロパティ ID を指定できます。

ServiceIdentifier.N

RepeatList

いいえ

Set

削除するサービスの ID。最大 10 個のサービス ID を指定できます。

EventIdentifier.N

RepeatList

いいえ

OfflineAlert

削除するイベントの ID。最大 10 個のイベント ID を指定できます。

ResourceGroupId

String

いいえ

rg-acfm4l5tcwd****

リソースグループ ID。

重要

IoT Platform は、インスタンスごとのみリソースグループ管理をサポートしています。ResourceGroupId パラメーターは無効です。このパラメーターを指定する必要はありません。

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

レスポンスパラメーター

パラメーター

タイプ

説明

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=DeleteThingModel
&ProductKeySource=a1rYuVF****
&PropertyIdentifier.1=speed
&ServiceIdentifier.1=SetSpeed
&EventIdentifier.1=SpeedAlarm
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

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

JSON 形式

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

エラーコード

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