調(diào)用該接口查詢指定設(shè)備上傳到物聯(lián)網(wǎng)平臺(tái)的所有文件列表。

使用說明

調(diào)用該接口返回的文件信息中，不包括文件下載地址。如需獲取文件下載地址，請(qǐng)調(diào)用QueryDeviceFile查詢。

QPS限制

單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為500。

說明 RAM用戶共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 QueryDeviceFileList

系統(tǒng)規(guī)定參數(shù)。取值：QueryDeviceFileList。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁面，查看當(dāng)前實(shí)例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會(huì)失敗。
  • 若無ID值，則無需傳入。

實(shí)例的更多信息，請(qǐng)參見實(shí)例概述。

PageSize Integer 否 10

返回結(jié)果中每頁顯示的文件記錄數(shù)量。最大取值200，默認(rèn)值是10。
ProductKey String 否 a1BwAGV****

要查詢的設(shè)備所隸屬的產(chǎn)品ProductKey。

說明 如果傳入該參數(shù)，需同時(shí)傳入DeviceName。
DeviceName String 否 light

要查詢的設(shè)備名稱。

說明 如果傳入該參數(shù)，需同時(shí)傳入ProductKey。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

要查詢的設(shè)備ID。物聯(lián)網(wǎng)平臺(tái)為該設(shè)備頒發(fā)的ID，設(shè)備的唯一標(biāo)識(shí)符。

說明 如果傳入該參數(shù)，則無需傳入ProductKey和DeviceName。IotId作為設(shè)備唯一標(biāo)識(shí)符，和ProductKey與DeviceName組合是一一對(duì)應(yīng)的關(guān)系。如果您同時(shí)傳入IotId和ProductKey與DeviceName組合，則以IotId為準(zhǔn)。
CurrentPage Integer 否 1

顯示返回結(jié)果中的第幾頁。最小取值1，默認(rèn)值 1。

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說明，請(qǐng)參見公共參數(shù)文檔。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見錯(cuò)誤碼。

CurrentPage Integer 1

當(dāng)前頁碼。
Data Array of FileSummary

調(diào)用成功時(shí)，返回的文件信息列表。
FileSummary
FileId String xL0G67MBLBDtkR7GCfT******

文件ID，文件的唯一標(biāo)識(shí)符。
Name String testFile2.txt

文件名稱。
Size String 1024000

文件大小，單位：KB。
UtcCreatedOn String 2019-03-21T08:45:42.000Z

文件創(chuàng)建時(shí)間。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)，返回的出錯(cuò)信息。
PageCount Integer 1

總頁數(shù)。
PageSize Integer 10

每頁顯示的文件個(gè)數(shù)。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。
Total Integer 2

文件總數(shù)。

示例

請(qǐng)求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceFileList
&ProductKey=a1BwAGV****
&DeviceName=deviceName1
&PageSize=10
&CurrentPage=1
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式 

<QueryDeviceFileListResponse>
  <PageCount>1</PageCount>
  <Data>
        <FileStoreSummary>
              <Name>testFile2.txt</Name>
              <FileId>xL0G67MBLBDtkR7GCfT******</FileId>
              <UtcCreatedOn>2019-03-21T08:45:42.000Z</UtcCreatedOn>
              <Size>102400</Size>
        </FileStoreSummary>
        <FileStoreSummary>
              <Name>testFile3.txt</Name>
              <FileId>6UCo1SqbqnQEoh9aKqD******</FileId>
              <UtcCreatedOn>2019-03-21T08:45:42.000Z</UtcCreatedOn>
              <Size>102400</Size>
        </FileStoreSummary>
        <FileStoreSummary>
              <Name>testFile1.txt</Name>
              <FileId>IhXXww3Eeu6uzSOSCyu******</FileId>
              <UtcCreatedOn>2019-03-21T08:45:40.000Z</UtcCreatedOn>
              <Size>102400</Size>
        </FileStoreSummary>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>7C7BA526-826D-46AA-A45E-55D21E6D1583</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>3</Total>
</QueryDeviceFileListResponse>

JSON格式 

{
  "PageCount": 1, 
  "Data": {
    "FileStoreSummary": [
      {
        "Name": "testFile2.txt", 
        "FileId": "xL0G67MBLBDtkR7GCfT******", 
        "UtcCreatedOn": "2019-03-21T08:45:42.000Z", 
        "Size": "102400"
      }, 
      {
        "Name": "testFile3.txt", 
        "FileId": "6UCo1SqbqnQEoh9aKqD******", 
        "UtcCreatedOn": "2019-03-21T08:45:42.000Z", 
        "Size": "102400"
      }, 
      {
        "Name": "testFile1.txt", 
        "FileId": "IhXXww3Eeu6uzSOSCyu******", 
        "UtcCreatedOn": "2019-03-21T08:45:40.000Z", 
        "Size": "102400"
      }
    ]
  }, 
  "PageSize": 10, 
  "RequestId": "7C7BA526-826D-46AA-A45E-55D21E6D1583", 
  "CurrentPage": 1, 
  "Success": true, 
  "Total": 3
}