調用ListFile列舉檔案-網盤與相簿服務-阿里雲

直接檔案夾下列舉檔案和檔案夾。

調試

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

授權資訊

當前API暫無授權資訊透出。

請求文法

POST /v2/file/list HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
domain_id	string	是
body	object	否	請求體參數。
share_id	string	否	分享 id。如果通過分享操作檔案，請攜帶`x-share-token` header 鑒權並傳遞此欄位，此時`drive_id`無效。否則請使用`aksk`或者`access_token`方式鑒權，並傳遞`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	否	設定結果從 marker 之後按字母排序的第一個開始返回。如果不設定，則從頭開始返回資料。預設值：無	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
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	否	設定 fields 時，可以返回子物件的額外資訊時，支援的欄位為： url 響應中返迴文件縮圖地址，下載地址 exif 響應中返迴文件的 exif 資訊 cropping_suggestion 響應中返迴文件的裁剪建議資訊 characteristic_hash 響應中返迴文件的特徵 hash 值 video_metadata 響應中返回視頻檔案的 meta 資訊，比如視頻時間長度，位元速率，高度，寬度等 video_preview_metadata 響應中返回視頻檔案的轉碼資訊，比如每個清晰度的轉碼資訊 investigation_info 響應中返回 investigation_info 欄位 dir_size 響應中返回每個子檔案夾的統計資訊 user_tags 響應中返回每個子物件的 user_tags 當需要多個資訊時，不同欄位以逗號分割，如 "url,dir_size,user_tags"	url,dir_size,user_tags
thumbnail_processes	object	否	縮圖配置，可一次性返回最多 5 個縮圖，map 的 key 可以自訂，返回時按 key 返回對應的縮圖連結
	ImageProcess	否	定義圖片、視頻、文檔的縮圖處理規則

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
items	array	檔案清單。
	File	檔案資訊
next_marker	string	下一頁起始資源標識符, 最後一頁該值為空白。	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

樣本

正常返回樣本

JSON格式

{
  "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,
            "source": "play basketball",
            "centric_score": 0.877
          }
        ],
        "faces": "[{\"FaceId\":\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\",\"GroupId\":\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\",\"FaceConfidence\":0.999,\"Age\":13,\"AgeConfidence\":4,\"Gender\":\"female\",\"GenderConfidence\":1,\"Emotion\":\"none\",\"EmotionConfidence\":0.672,\"FaceAttributes\":{\"Mask\":\"none\",\"MaskConfidence\":0.894,\"Beard\":\"none\",\"BeardConfidence\":0.997,\"Glasses\":\"none\",\"GlassesConfidence\":0.999,\"Mouth\":\"close\",\"MouthConfidence\":0.937,\"Hat\":\"none\",\"HatConfidence\":0.998,\"HeadPose\":{\"Pitch\":10.684,\"Roll\":-10.707,\"Yaw\":-20.094},\"FaceBoundary\":{\"Width\":457,\"Height\":687,\"Top\":1324,\"Left\":1356}}}]",
        "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": {
        "time": "2006-01-02T15:04:05.000Z07:00",
        "width": 1920,
        "height": 1080,
        "location": "30.185453,120.218522",
        "country": "China",
        "province": "Zhejiang",
        "city": "Hangzhou",
        "district": "Xihu",
        "township": "Xihu",
        "address_line": "Zhejiang hangzhou xihu",
        "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"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。