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

プロダクトのカスタム Topic カテゴリを作成します。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	CreateProductTopic	実行する操作。値を CreateProductTopic に設定します。
Operation	String	Yes	PUB	カスタム Topic カテゴリに対するデバイスの権限。有効な値： SUB: サブスクライブ。 PUB: パブリッシュ。 ALL: パブリッシュとサブスクライブ。
ProductKey	String	Yes	aldDEin****	カスタム Topic カテゴリを作成するプロダクトの ProductKey。
TopicShortName	String	Yes	submit	カスタム Topic カテゴリの名前。 Topic カテゴリは複数のフィールドで構成されます。フィールドはスラッシュ (`/`) で区切ります。名前には、文字、数字、およびアンダースコア (_) を使用できます。 Topic カテゴリの各レベル名は空にできません。説明 Operation を SUB に設定した場合、 Topic カテゴリの名前にプラス記号 (`+`) とシャープ記号 (`#`) のワイルドカード文字を指定して、デバイスが一度に複数の Topic をサブスクライブできるようにすることができます。ワイルドカード文字の使用方法の詳細については、「ワイルドカード文字を含むカスタム Topic」をご参照ください。クラウドゲートウェイプロダクトを使用する場合、プレフィックスは自動的に指定されません。パラメーターにカスタム値を指定する必要があります。 `${deviceName}` を使用して DeviceName を指定できます。クラウドゲートウェイ以外のプロダクトを使用する場合、`/${productKey}/${deviceName}/user/` が TopicShortName の値のプレフィックスとして自動的に指定されます。 Topic カテゴリのカスタム名を指定するだけで済みます。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの [概要] タブで確認できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに ID がない場合は、パラメーターを設定する必要はありません。インスタンスの詳細については、「概要」をご参照ください。
Desc	String	No	submit a test topic	カスタム Topic カテゴリの説明。説明は最大 100 文字まで入力できます。
EnableProxySubscribe	Boolean	No	false	Operation を SUB または ALL に設定した場合、委任サブスクリプション機能を有効にできます。有効な値： true: 委任サブスクリプション機能を有効にします。 false: 委任サブスクリプション機能を無効にします。 Topic の委任サブスクリプション機能を有効にすると、デバイスを IoT Platform に接続したときに、IoT Platform が Topic の詳細を取得し、デバイスが Topic をサブスクライブするのを支援します。
Codec	String	No	compress	カスタム Topic のデータ圧縮または展開機能を有効にするかどうかを指定します。このパラメーターは、標準または排他的 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: 呼び出しは失敗しました。
TopicId	Long	10000	カスタム Topic カテゴリの ID。呼び出しが成功した場合、ID は IoT Platform によって発行されます。説明カスタム Topic カテゴリ ID は機密にしてください。カスタム Topic カテゴリ ID は、カスタム Topic カテゴリに関連する特定の操作を呼び出すときに必要です。

例

リクエストの例

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

成功レスポンスの例

XML 形式

<CreateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
      <TopicId>10000</TopicId>
</CreateProductTopicResponse>

JSON 形式

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

エラーコード

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