UpdateProductTopic - IoT Platform - Alibaba Cloud ドキュメントセンター

カスタム Topic カテゴリを変更します。

QPS 制限

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

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	UpdateProductTopic	実行する操作。値を UpdateProductTopic に設定します。
Operation	String	Yes	PUB	Topic カテゴリに対するデバイスの権限。有効な値： SUB: サブスクライブ PUB: パブリッシュ ALL: パブリッシュとサブスクライブ
TopicId	String	Yes	821****	変更する Topic カテゴリの ID。 CreateProductTopic 操作の呼び出し後にカスタム Topic カテゴリが作成された場合、TopicId で示される Topic カテゴリ ID が返されます。
TopicShortName	String	Yes	resubmit	カスタムカテゴリレベルの名前。デフォルトでは、Topic カテゴリには _productkey_ と _devicename_ のレベルが含まれています。 2 つのレベルはスラッシュ (/) で区切ります。 Topic カテゴリの形式: `productKey/deviceName/topicShortName`。説明各レベルには、文字、数字、アンダースコア (_) を使用できます。空にすることはできません。
IotInstanceId	String	Optional	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの [概要] タブでインスタンスの ID を取得できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに ID がない場合は、パラメーターを設定する必要はありません。インスタンスの詳細については、「概要」をご参照ください。
Desc	String	No	resubmit a test topic	Topic カテゴリの説明。説明は 1 ～ 100 文字である必要があります。
EnableProxySubscribe	Boolean	No	false	Operation を SUB または ALL に設定した場合、委任サブスクリプション機能を有効にできます。有効な値： true: 委任サブスクリプション機能を有効にします。 false: 委任サブスクリプション機能を無効にします。 Topic の委任サブスクリプション機能を有効にすると、デバイスを IoT Platform に接続したときに、IoT Platform が Topic の詳細を取得し、デバイスが Topic をサブスクライブするのを支援します。
Codec	String	No	compress	カスタム Topic のデータ圧縮または展開機能を有効にするかどうかを指定します。このパラメーターは、Standard または Exclusive Enterprise Edition インスタンスを使用する場合にのみ使用できます。有効な値： compress: データ圧縮を有効にします。 decompress: データ展開を有効にします。詳細については、「データ圧縮」をご参照ください。重要 TopicShortName にワイルドカード文字 (`+` と `#`) を含む値を指定した場合、Codec を設定することはできません。ワイルドカード文字を使用して Topic カテゴリを作成するときにデータ圧縮または展開機能が有効になっている場合、このリクエストは失敗します。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	FCC27691-9151-4B93-9622-9C90F30542EC	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateProductTopic
&TopicId=821****
&TopicShortName=resubmit
&Operation=PUB
&Desc=resubmit a test topic
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<UpdateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
</UpdateProductTopicResponse>

JSON 形式

{
    "RequestId":"FCC27691-9151-4B93-9622-9C90F30542EC",
    "Success":true
}

エラーコード

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