PDS の ListFile でファイルとフォルダーのリストをクエリ - PDS

指定されたフォルダの直下にあるファイルとフォルダを一覧表示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST /v2/file/list HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意
share_id	string	任意	share ID。ファイルを共有する場合、リクエストで認証用の `x-share-token` ヘッダーを渡し、`share_id` を指定します。この場合、`drive_id` は無効です。それ以外の場合は、認証に AccessKey ペアまたはアクセストークンを使用し、`drive_id` を指定します。`share_id` と `drive_id` のいずれかを指定する必要があります。	7JQX1FswpQ8
drive_id	string	任意	ドライブ ID。	1
parent_file_id	string	必須	親フォルダの ID。親フォルダがルートディレクトリの場合、このパラメーターを `root` に設定します。	root
limit	integer	任意	返される結果の最大数。有効な値: 1～100。返されるエントリの数は、このパラメーターの値以下である必要があります。	50
marker	string	任意	リストが開始されるエントリの名前。このパラメーターの値の後にアルファベット順で続く名前のエントリが返されます。このパラメーターを指定しない場合、すべてのエントリが返されます。このパラメーターはデフォルトで空です。	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
status	string	任意	返されるファイルの状態。有効な値: `available`: 通常のファイルのみを返します。 `uploading`: アップロード中のファイルのみを返します。デフォルトでは、`available` 状態のファイルのみが返されます。列挙値: available : uploading :	available
order_by	string	任意	ソートフィールド。有効な値: `created_at`: 作成時間でエントリをソートします。 `updated_at`: 更新時間でエントリをソートします。 `size`: ファイルサイズでエントリをソートします。 `name`: ファイル名でエントリをソートします。デフォルト値: `created_at`。列挙: `updated_at`: 更新時間 `size`: ファイルサイズ `name`: ファイル名 `created_at`: 作成時間列挙値: updated_at : size : name : created_at :	updated_at
order_direction	string	任意	ソート順。有効な値: `ASC`: 昇順 `DESC`: 降順デフォルト値: `ASC`。列挙値: ASC : DESC :	ASC
category	string	任意	ファイルカテゴリ。有効な値: `app`: インストールパッケージ `zip`: 圧縮パッケージ `image`: イメージ `doc`: ドキュメント `video`: ビデオ `audio`: オーディオ `others`: その他デフォルトでは、すべてのカテゴリのファイルが返されます。列挙値: app : app zip : zip image : image doc : doc video : video audio : audio others : others	image
type	string	任意	ファイルタイプ。有効な値: `file`: ファイルのみを返します。 `folder`: フォルダのみを返します。デフォルトでは、すべてのタイプのファイルが返されます。列挙値: file : folder :	file
fields	string	任意	子主題に関する追加情報を返すために使用されるフィールド。有効な値: `url`: 応答でファイルのサムネイルの URL を返します。 `exif`: 応答でファイルの Exchangeable Image File Format (EXIF) データを返します。 `cropping_suggestion`: 応答でファイルのトリミング候補を返します。 `characteristic_hash`: 応答でファイルの特性ハッシュ値を返します。 `video_metadata`: 応答でビデオの長さ、ビットレート、高さ、幅などのビデオファイルのメタデータを返します。 `video_preview_metadata`: 応答で各定義のトランスコード仕様などのビデオファイルのトランスコード情報を返します。 `investigation_info`: 応答で調査情報を返します。 `dir_size`: 応答で各サブフォルダの統計を返します。 `user_tags`: 応答で各子主題のユーザータグを返します。複数のフィールドはコンマ (,) で区切って指定できます。例: "url,dir_size,user_tags"。	url,dir_size,user_tags
thumbnail_processes	object	任意	サムネイル構成。一度に最大 5 つのサムネイルを返すことができます。値にはキーと値のペアが含まれます。キーはカスタマイズできます。サムネイルの URL はキーに基づいて返されます。
	ImageProcess	任意	イメージ、ビデオ、ドキュメントのサムネイルを生成するために使用されるルール。

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
items	array	ファイルリスト。
	File	ファイル情報
next_marker	string	次のページの開始リソースの識別子。この値は最後のページでは空です。	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

例

成功レスポンス

JSONJSON

{
  "items": [
    {
      "domain_id": "bj1",
      "drive_id": "1",
      "file_id": "5d79206586bb5dd69fb34c349282718146c55da7",
      "name": "1.mov",
      "type": "file",
      "content_type": "application/json",
      "created_at": "2019-08-20T06:51:27.292Z",
      "updated_at": "2019-08-20T06:51:27.292Z",
      "description": "image file",
      "trashed_at": "2019-08-20T06:51:27.292Z",
      "file_extension": "txt",
      "hidden": false,
      "size": 1024,
      "starred": false,
      "status": "available",
      "labels": [
        "[\"label1:1\", \"label2:2\"]"
      ],
      "upload_id": "C9DCFE5A82644AC7A02DB74C30C934A6",
      "parent_file_id": "3d5b846942cf94fa72324c8a4bda34e81da635a",
      "crc64_hash": "3574582125365864471",
      "content_hash": "EA4942AA8761213890A5C386F88E6464D2C31CA3",
      "content_hash_name": "sha1",
      "download_url": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
      "thumbnail": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
      "category": "image",
      "local_created_at": "2019-08-20T06:51:27.292Z",
      "local_modified_at": "2019-08-20T06:51:27.292Z",
      "revision_id": "5d5b846942cf94fa72324c14a4bda34e81da635d",
      "thumbnail_urls": {
        "key": "\"128X128\": \"https://url1\", \"800X800\": \"url2\""
      },
      "image_media_metadata": {
        "time": "2006-01-02T15:04:05.000Z07:00",
        "width": 1024,
        "height": 1024,
        "location": "30.185453,120.218522",
        "country": "China",
        "province": "Zhejiang",
        "city": "Hangzhou",
        "district": "Xihu",
        "township": "Xihu",
        "address_line": "Zhejiang hangzhou xihu",
        "image_tags": [
          {
            "confidence": 0.98,
            "parent_name": "sport",
            "name": "basketball",
            "tag_level": 3,
            "centric_score": 0.877
          }
        ],
        "faces_thumbnail": [
          {
            "face_id": "a9a66a86-73dd-4c95-8b79-1d8a49db5226",
            "face_group_id": "Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0",
            "face_thumbnail": "https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2"
          }
        ],
        "exif": "{\"Compression\":{\"value\":\"6\"},\"DateTime\":{\"value\":\"2020:08:19 17:11:11\"}}",
        "image_quality": {
          "overall_score": 0.736
        }
      },
      "user_tags": {
        "key": "\"k1\":\"v1\", \"k2\",\"v2\""
      },
      "video_media_metadata": {
        "width": 1920,
        "height": 1080,
        "video_media_video_stream": [
          {
            "duration": "22.88",
            "bitrate": "108420",
            "code_name": "h264",
            "frame_count": "90"
          }
        ],
        "video_media_audio_stream": [
          {
            "duration": "7704.573000",
            "bit_rate": "129280",
            "code_name": "aac"
          }
        ]
      },
      "id_path": "id1/id2",
      "name_path": "root/f1/f2",
      "dir_size_info": {
        "dir_count": 1,
        "file_count": 10
      },
      "action_list": [
        ""
      ],
      "auto_delete_left_sec": 0
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。