全部產品
Search
文件中心

IoT Platform:ListParserDataSource

更新時間:Feb 17, 2025

調用該介面查詢所有資料來源列表。

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
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 iot.system.SystemException An internal error occurred. Try again later. 系統異常。
400 iot.system.IllegalRequest The request parameter is invalid. 非法的請求參數。
400 iot.rule.NotFoundRule there are no rules. 規則不存在。

訪問錯誤中心查看更多錯誤碼。