调用该接口分页查询规则引擎中指定数据源下的Topic列表。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为10。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListDataSourceItem

系统规定参数。取值：ListDataSourceItem。
DataSourceId Long 是 1001

数据源ID。

调用ListParserDataSource接口，可查看当前实例下所有数据源ID。

Page Integer 是 1

指定显示返回结果中的第几页，取值范围为1~100,000。
PageSize Integer 是 10

指定返回结果中每页显示的记录数量，取值范围为1~100。
IotInstanceId String 否 iot-0pp1n8t***

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。

SearchName String 否 thing

传入Topic值中任意一段字符串，根据该字符串检索能匹配的Topic。

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

返回数据

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

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

DataSourceItems Array of dataSourceItem

返回的Topic列表信息。
dataSourceItem
DataSourceItemId Long 129322

数据源Topic的ID。
DeviceName String lightDevice

消息Topic所属的设备名称。

说明 消息Topic属于开源MQTT托管形态产品和设备或MQTT云网关产品和设备时，返回该参数。
ProductKey String aw3****

消息Topic所属产品的ProductKey。

说明 消息Topic属于开源MQTT托管形态产品和设备，或MQTT云网关产品和设备时，返回该参数。
ScopeType String PRODUCT

消息Topic订阅的作用域，可取值：

  • PRODUCT ：产品维度，表示作用在产品下的所有设备上。
  • DEVICE ：设备维度，表示作用在产品下指定的设备上。
说明 消息Topic属于开源MQTT托管形态产品和设备，或MQTT云网关产品和设备时，返回该参数。
Topic String /gyh***z/+/thing/event/property/post

数据源Topic的具体值。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
Page Integer 1

显示返回结果中的第几页。
PageSize Integer 10

返回结果中每页显示的记录数量。

RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。
Total Integer 100

返回结果记录总数。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDataSourceItem
&DataSourceId=1001
&Page=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式 

<ListDataSourceItemResponse>
  <DataSourceItems>
        <dataSourceItem>
              <DataSourceItemId>129322</DataSourceItemId>
              <Topic>/gyh***z/+/thing/event/property/post</Topic>
        </dataSourceItem>
  </DataSourceItems>
  <PageSize>1</PageSize>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Total>1</Total>
  <Page>1</Page>
  <Success>true</Success>
</ListDataSourceItemResponse>

JSON格式 

{
    "DataSourceItems": {
        "dataSourceItem": [
            {
                "DataSourceItemId": "129322",
                "Topic": "/gyh***z/+/thing/event/property/post"
            }
        ]
    },
    "PageSize": "1",
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": "1",
    "Page": "1",
    "Success": "true"
}

错误码

HttpCode 错误码 错误信息 描述
400 iot.system.SystemException An internal error occurred. Try again later. 系统异常。
400 iot.common.InvalidPageParams The specified pagination size or pagination parameter is invalid. 分页大小或者分页页号不合法。
400 Iot.Device.NotExistedDevice The device does not exist. 设备不存在或未激活。

访问错误中心查看更多错误码。