調用該接口查詢指定產品下自定義Topic類列表的詳細信息。
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。 重要
實例的更多信息,請參見實例概述。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
Data | Array of ProductTopicInfo | 調用成功時,返回的Topic類信息列表。詳情參見以下ProductTopicInfo。 |
|
ProductTopicInfo | |||
Codec | String | compress | 是否開啟自定義Topic數據壓縮或解壓縮。 取值:
數據壓縮功能詳細內容,請參見數據壓縮。 |
Desc | String | topicDesc | Topic類的描述信息。 |
EnableProxySubscribe | Boolean | false | 是否開啟代理訂閱。 取值:
開啟代理訂閱后,設備與物聯網平臺建連時,物聯網平臺查詢已開啟代理訂閱的Topic,幫助設備完成訂閱。 |
Id | String | 821**** | Topic類的ID。 |
Operation | String | 1 | 設備對該Topic類的操作權限,取值:
|
ProductKey | String | HMyB*** | 產品的ProductKey。 |
TopicShortName | String | /HMyB***/${deviceName}/user/get | 產品的自定義Topic類。 |
ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯信息。 |
RequestId | String | B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
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
}
文檔內容是否對您有幫助?