調用該接口分頁查詢規則引擎中指定數據源下的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. 設備不存在或未激活。

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