调用ListFile列举文件_网盘与相册服务-阿里云帮助中心

直接文件夹下列举文件和文件夹。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/file/list

请求参数

名称	类型	必填	描述	示例值
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
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
category	string	否	文件分类，可选字段如下： app：安装包 zip：压缩包 image：图片 doc：文档 video：视频 audio：音频 others：其他默认返回所有分类文件	image
type	string	否	文件类型，可选字段如下： file：只返回文件 folder：只返回文件夹默认返回所有类型文件	file
fields	string	否	筛选返回字段：当填 * 时，返回文件所有字段（必须进行设置的除外）；当只需要特定字段时，可设置为：url、exif、cropping_suggestion、characteristic_hash、video_metadata、video_preview_metadata，当需要多个字段时，以逗号 , 分割，如 url, exif; 当需要时必须进行设置才会返回的字段：investigation_info 默认返回所有字段（必须进行设置的除外）	*

返回参数

名称	类型	描述	示例值
	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": "共用文件",
      "trashed_at": "2019-08-20T06:51:27.292Z",
      "file_extension": "txt",
      "mime_type": "video/quicktime",
      "mime_extension": "mov",
      "hidden": false,
      "size": 1024,
      "starred": false,
      "status": "available",
      "user_meta": "k1=v1,k2=v2",
      "labels": [
        ""
      ],
      "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",
      "investigation_info": {
        "status": 4,
        "suggestion": "pass"
      }
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}

错误码

访问错误中心查看更多错误码。