QueryProductTopic でカスタム Topic カテゴリをクエリ - IoT

プロダクトのカスタムトピックカテゴリの詳細をクエリします。

QPS 制限

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

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

デバッグ

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

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	Yes	QueryProductTopic	実行する操作。値を QueryProductTopic に設定します。
ProductKey	String	Yes	HMyB*******	プロダクトの ProductKey。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの ID を取得できます。重要インスタンスに ID がある場合は、このパラメータを設定する必要があります。設定しないと、呼び出しは失敗します。インスタンスに ID がない場合は、このパラメータを設定する必要はありません。詳細については、「インスタンスの概要」をご参照ください。

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

レスポンスパラメータ

パラメータ	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	ProductTopicInfo の配列		呼び出しが成功した場合に返されるカスタムトピックカテゴリ。詳細については、ProductTopicInfo をご参照ください。
ProductTopicInfo
Codec	String	compress	カスタムトピックカテゴリでデータ圧縮またはデータ展開機能が有効になっているかどうかを示します。有効な値： compress: データ圧縮機能が有効になっています。 decompress: データ展開機能が有効になっています。詳細については、「データ圧縮」をご参照ください。
Desc	String	topicDesc	カスタムトピックカテゴリの説明。
EnableProxySubscribe	Boolean	false	委任サブスクリプション機能が有効になっているかどうかを示します。有効な値： true: 委任サブスクリプション機能が有効になっています。 false: 委任サブスクリプション機能は無効になっています。トピックの委任サブスクリプション機能を有効にすると、デバイスを IoT Platform に接続したときに、IoT Platform がトピックの詳細を取得し、デバイスがトピックにサブスクライブするのを支援します。
Id	String	821****	カスタムトピックカテゴリの ID。
Operation	String	1	カスタムトピックカテゴリでデバイスに付与する権限。有効な値： 0: パブリッシュ。 1: サブスクライブ。 2: パブリッシュとサブスクライブ。
ProductKey	String	HMyB***	プロダクトの ProductKey。
TopicShortName	String	/HMyB***/${deviceName}/user/get	カスタムトピックカテゴリの名前。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

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

成功レスポンスの例

XML 形式

<QueryProductTopicResponse>
  <RequestId>310E4A1E-B614-5607-B7DB-55530CAE074A</RequestId>
  <Data>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/get</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>1</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/update</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>0</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/update/error</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>0</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
  </Data>
  <Success>true</Success>
</QueryProductTopicResponse>

JSON 形式

{
    "RequestId": "310E4A1E-B614-5607-B7DB-55530CAE074A",
    "Data": {
        "ProductTopicInfo": [
            {
                "TopicShortName": "/g18******F/${deviceName}/user/get",
                "EnableProxySubscribe": false,
                "Operation": "1",
                "Id": "3679****",
                "ProductKey": "g18******F"
            },
            {
                "TopicShortName": "/g18******F/${deviceName}/user/update",
                "EnableProxySubscribe": false,
                "Operation": "0",
                "Id": "3679****",
                "ProductKey": "g18******F"
            },
            {
                "TopicShortName": "/g18******F/${deviceName}/user/update/error",
                "EnableProxySubscribe": false,
                "Operation": "0",
                "Id": "3679****",
                "ProductKey": "g18******F"
            }
        ]
    },
    "Success": true
}

エラーコード

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