调用该接口为指定设备订阅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值,则无需传入。

实例的更多信息,请参见如何获取实例ID

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

ErrorMessage String 系统异常

调用失败时,返回的出错信息。

FailureTopics List ["/2Fx7aWKW9***/FdeviceNameTest2/user/delete"]

订阅失败时返回的Topic列表。例如Topic不属于当前设备,或Topic不存在,都会订阅失败。

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
}