調用該介面查詢裝置已訂閱的Topic列表。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為100。
說明 RAM使用者共用阿里雲帳號配額。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | QueryDeviceSubTopic | 系統規定參數。取值:QueryDeviceSubTopic。 |
| ProductKey | String | 是 | hf768**** | 要查詢裝置所屬產品的ProductKey。 您可以在物聯網平台控制台或調用QueryProductList查看產品的資訊。 |
| DeviceName | String | 是 | device1 | 要查詢裝置的裝置名稱。 您可以在物聯網平台控制台或調用QueryDeviceInfo查看裝置的資訊。 |
| IotInstanceId | String | 否 | iot-cn-0pp1n8t**** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 表示是否調用成功。
|
| TopicList | Array of topic | 調用成功後,返回的裝置已訂閱Topic資訊。 |
|
| Timestamp | Long | 1662039965873 | 訂閱Topic的時間,單位為毫秒。 |
| TopicName | String | /hf768****/device1/user/test | 已訂閱的裝置Topic。 |
樣本
請求樣本
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceSubTopic
&ProductKey=hf768****
&DeviceName=device1
&<公用請求參數>
正常返回樣本
XML格式
<QueryDeviceSubTopicResponse>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<TopicList>
<Timestamp>1662039965873</Timestamp>
<TopicName>/hf768****/device1/user/test</TopicName>
</TopicList>
<TopicList>
<Timestamp>1662039965873</Timestamp>
<TopicName>/hf768****/device1/user/down</TopicName>
</TopicList>
<Success>true</Success>
</QueryDeviceSubTopicResponse>
JSON格式
{
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"TopicList": [
{
"Timestamp": 1662039965873,
"TopicName": "/hf768****/device1/user/test"
},
{
"Timestamp": 1662039965873,
"TopicName": "/hf768****/device1/user/down"
}
],
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。