調用該接口查詢設備已訂閱的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。

注意
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無實例概覽頁面或ID值，則無需傳入。

實例的更多信息，請參見實例概述。

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

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

阿里云為該請求生成的唯一標識符。
Success Boolean true

表示是否調用成功。

  • true：調用成功。
  • false：調用失敗。
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
}