调用该接口查询设备已订阅的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
}