調用該接口為指定設備訂閱Topic。

使用說明

  • 待訂閱Topic所屬設備，必須已經接入物聯網平臺并激活在線。
  • 調用本接口僅訂閱指定設備的Topic，且單次調用最多訂閱10個Topic。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為10。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 SubscribeTopic

系統規定參數。取值：SubscribeTopic。
DeviceName String 是 device1

指定要訂閱Topic所屬設備的DeviceName。

ProductKey String 是 a1Q5XoY***

設備所屬產品的ProductKey。

Topic.N RepeatList 是 /a1Q5XoY***/device1/user/get

要訂閱的Topic，最多訂閱10個Topic。

Topic的操作權限必須為訂閱或發布和訂閱。

IotInstanceId String 否 iot-06***

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無ID值，則無需傳入。

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

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

返回數據

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

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

ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String BB71E443-4447-4024-A000-EDE09922891E

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

表示是否調用成功。

  • true：調用成功。
  • false：調用失敗。

示例

請求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=SubscribeTopic
&DeviceName=device1
&ProductKey=a1Q5XoY***
&Topic.1=/a1Q5XoY***/device1/user/get
&Topic.2=/a1Q5XoY***/device1/user/add
&<公共請求參數>

正常返回示例

XML格式 

<SubscribeTopicResponse>
  <RequestId>32B9828A-25DD-48E2-8E26-D1664B341940</RequestId>
  <Success>true</Success>
</SubscribeTopicResponse>

JSON格式 

{
    "RequestId": "32B9828A-25DD-48E2-8E26-D1664B341940",
    "Success": true
}