QueryDeviceFile - IoT Platform - Alibaba Cloud ドキュメントセンター

デバイスから IoT Platform にアップロードされたファイルに関する情報をクエリします。

制限

各 Alibaba Cloud アカウントは、最大 500 クエリ/秒（QPS）を実行できます。

説明

Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。OpenAPI Explorer は署名の値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceFile	実行する操作。値を QueryDeviceFile に設定します。
FileId	String	はい	xL0G67MBLBDtkR7GCfT******	QueryDeviceFileList 操作を呼び出し、レスポンスでファイル ID を表示できます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターを構成する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに[概要] ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	いいえ	light	デバイスの名前。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。デバイス ID は IoT Platform によって発行されます。説明このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。IotId パラメーターは、ProductKey と DeviceName の組み合わせに対応する、デバイスのグローバル一意識別子（GUID）を指定します。IotId と ProductKey と DeviceName の組み合わせの両方を指定した場合、IotId が優先されます。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるファイル情報。
DownloadUrl	String	http://iotx-file-store.oss-cn-shanghai.aliyuncs.com/device_file/A849****/aGE**/testFile3.txt?Expires=1553162075&OSSAccessKeyId=LTAI************&Signature=%2F8****	ファイルのダウンロード URL。
FileId	String	6UCo1SqbqnQEoh9aKqDQ01****	ファイルの ID。
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	リクエストの ID。
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/A849******/aGE******/testFile3.txt?Expires=1553162075&OSSAccessKeyId=LTAI****************&Signature=%2F8******</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/A849******/aGE******/testFile3.txt?Expires=1553162075&OSSAccessKeyId=LTAI****************&Signature=%2F8******",
    "FileId": "6UCo1SqbqnQEoh9aKqDQ01****",
    "UtcCreatedOn": "2019-03-21T08:45:42.000Z",
    "Size": "102400"
  },
  "Success": true
}

エラーコード

エラーコードのリストについては、API エラーセンターを参照してください。