QueryDeviceFile - IoT Platform

調用該介面查詢指定裝置上傳到物聯網平台的指定檔案資訊。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為500。

說明

RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceFile	系統規定參數。取值：QueryDeviceFile。
FileId	String	是	xL0G67MBLBDtkR7GCfT******	檔案標識符。您可以調用QueryDeviceFileList，從返回結果中查看檔案ID。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	a1BwAGV****	要查詢的裝置所隸屬的產品ProductKey。說明如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	否	light	要查詢的裝置名稱。說明如果傳入該參數，需同時傳入ProductKey。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	要查詢的裝置ID。物聯網平台為該裝置頒發的ID，裝置的唯一識別碼。說明如果傳入該參數，則無需傳入ProductKey和DeviceName。IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的檔案資訊。
DownloadUrl	String	http://iotx-file-store.oss-cn-shanghai.aliyuncs.com/device_file/A849E4E5CFF64804A18D9384AC9D**/aGEKIpp5NAGxdP2oo90000/testFile3.txt?Expires=1553162075&OSSAccessKeyId=LTAI************&Signature=%2F88xdEFPukJ%2F8**%2Bdv3io%3D	檔案下載URL。
FileId	String	6UCo1SqbqnQEoh9aKqDQ01****	檔案標識符。
Name	String	testFile3.txt	檔案名稱。
Size	String	102400	檔案大小，單位：KB。
UtcCreatedOn	String	2019-03-21T08:45:42.000Z	檔案建立時間。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceFile
&ProductKey=a1BwAGV****
&DeviceName=deviceName1
&FileId=6UCo1SqbqnQEoh9aKqD******
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceFileResponse>
  <RequestId>93C5276D-5C8A-40D9-BFD6-4BD5B8C1A08F</RequestId>
  <Data>
        <Name>testFile3.txt</Name>
        <DownloadUrl>http://iotx-file-store.oss-cn-shanghai.aliyuncs.com/device_file/A849E4E5CFF64804A18D9384AC9D****/aGEKIpp5NAGxdP2oo90000****/testFile3.txt?Expires=1553162075&amp;OSSAccessKeyId=LTAI****************&amp;Signature=%2F88xdEFPukJ****%2F8****%2Bdv3io%3D</DownloadUrl>
        <FileId>6UCo1SqbqnQEoh9aKqDQ01****</FileId>
        <UtcCreatedOn>2019-03-21T08:45:42.000Z</UtcCreatedOn>
        <Size>102400</Size>
  </Data>
  <Success>true</Success>
</QueryDeviceFileResponse>

JSON格式

{
  "RequestId": "93C5276D-5C8A-40D9-BFD6-4BD5B8C1A08F",
  "Data": {
    "Name": "testFile3.txt",
    "DownloadUrl": "http://iotx-file-store.oss-cn-shanghai.aliyuncs.com/device_file/A849E4E5CFF64804A18D9384AC9D****/aGEKIpp5NAGxdP2oo90000****/testFile3.txt?Expires=1553162075&OSSAccessKeyId=LTAI****************&Signature=%2F88xdEFPukJ****%2F8****%2Bdv3io%3D",
    "FileId": "6UCo1SqbqnQEoh9aKqDQ01****",
    "UtcCreatedOn": "2019-03-21T08:45:42.000Z",
    "Size": "102400"
  },
  "Success": true
}

錯誤碼

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