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

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

制限

この操作呼び出しで返されるファイル情報には、ダウンロード URL は含まれていません。ファイルのダウンロード URL を取得するには、QueryDeviceFile を呼び出します。
各 Alibaba Cloud アカウントは、最大 500 クエリ/秒（QPS）を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	QueryDeviceFileList	実行する操作。値を QueryDeviceFileList に設定します。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
PageSize	Integer	No	10	各ページに返すエントリの数。最大値：200。デフォルト値：10。
ProductKey	String	No	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	No	light	デバイスの DeviceName。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。デバイス ID は IoT Platform によって発行されます。説明このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。IotId パラメーターは、ProductKey と DeviceName の組み合わせに対応する、デバイスのグローバル一意識別子（GUID）を指定します。IotId と ProductKey と DeviceName の組み合わせの両方を指定した場合、IotId が優先されます。
CurrentPage	Integer	No	1	返すページの番号。ページは 1 ページ目から始まります。デフォルト値：1。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
CurrentPage	Integer	1	返されたページの番号。
Data	FileSummary の配列		呼び出しが成功した場合に返されるファイルリスト情報。
FileSummary
FileId	String	xL0G67MBLBDtkR7GCfT******	各ファイルの ID。ID はファイルの一意の識別子です。
Name	String	testFile2.txt	ファイルの名前。
Size	String	1024000	ファイルのサイズ。単位：KB。
UtcCreatedOn	String	2019-03-21T08:45:42.000Z	ファイルが作成された日時。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
PageCount	Integer	1	ページの総数。
PageSize	Integer	10	1 ページあたりに返されるエントリの数。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true：呼び出しは成功しました。 false：呼び出しは失敗しました。
Total	Integer	2	ファイルの総数。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceFileList
&ProductKey=a1BwAGV****
&DeviceName=deviceName1
&PageSize=10
&CurrentPage=1
&<Common request parameters>

成功レスポンスの例

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
}

エラーコード

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