QueryProductTopic - IoT Platform

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為3。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryProductTopic	系統規定參數。取值：QueryProductTopic。
ProductKey	String	是	HMyB*******	要查詢Topic類的產品ProductKey。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of ProductTopicInfo		調用成功時，返回的Topic類資訊列表。詳情參見以下ProductTopicInfo。
ProductTopicInfo
Codec	String	compress	是否開啟自訂Topic資料壓縮或解壓縮。取值： compress：壓縮。 decompress：解壓縮。資料壓縮功能詳細內容，請參見資料壓縮。
Desc	String	topicDesc	Topic類的描述資訊。
EnableProxySubscribe	Boolean	false	是否開啟代理訂閱。取值： true：開啟。 false：不開啟。開啟代理訂閱後，裝置與物聯網平台建連時，物聯網平台查詢已開啟代理訂閱的Topic，協助裝置完成訂閱。
Id	String	821****	Topic類的ID。
Operation	String	1	裝置對該Topic類的操作許可權，取值： 0：發布 1：訂閱 2：發布和訂閱
ProductKey	String	HMyB***	產品的ProductKey。
TopicShortName	String	/HMyB***/${deviceName}/user/get	產品的自訂Topic類。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD	阿里雲為該請求產生的唯一識別碼。
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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。