调用该接口查询所有数据源列表。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值:ListParserDataSource。

Page Integer 是 1

指定显示返回结果中的第几页,默认值为1,取值范围为1~100。

PageSize Integer 是 10

指定返回结果中每页显示的记录数量,默认值为10,最大值不超过100。

IotInstanceId String 否 iot-2w****

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

注意
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无实例概览页面或ID值,则无需传入。

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

SearchName String 否 DataSource

传入数据源名称中任意字符串,根据该字符串检索能匹配的数据源名称。

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

返回数据

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

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

Data Array of DataSource

返回的数据源列表信息。

DataSource
DataSourceId Long 1001

数据源ID。

Description String 设备数据。

数据源描述信息。

Name String DataSource

数据源名称。

UtcCreated String 2022-03-27T12:45:43.000Z

创建数据源的UTC时间。格式为yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。

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=ListParserDataSource
&Page=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<ListParserDataSourceResponse>
  <Data>
        <DataSource>
              <Description>设备1数据。</Description>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <DataSourceId>1001</DataSourceId>
              <Name>DataSource1</Name>
        </DataSource>
        <DataSource>
              <Description>设备2数据。</Description>
              <UtcCreated>2022-04-27T12:45:43.000Z</UtcCreated>
              <DataSourceId>1002</DataSourceId>
              <Name>DataSource2</Name>
        </DataSource>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Total>100</Total>
  <Page>1</Page>
  <Success>true</Success>
</ListParserDataSourceResponse>

JSON格式

{
    "Data": {
        "DataSource": [
            {
                "Description": "设备1数据。",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "DataSourceId": 1001,
                "Name": "DataSource1"
            },
            {
                "Description": "设备2数据。",
                "UtcCreated": "2022-04-27T12:45:43.000Z",
                "DataSourceId": 1002,
                "Name": "DataSource2"
            }
        ]
    },
    "PageSize": 10,
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": 100,
    "Page": 1,
    "Success": true
}