ListDataSourceItem - IoT Platform

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.	裝置不存在或未啟用。

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