文档

ListCdsFiles - 查询网盘文件及获取文件下载链接

更新时间:

查询网盘中的文件列表,以及获取文件的下载链接。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:ListCdsFiles
  • 全部资源
    *

请求参数

名称类型必填描述示例值
EndUserIdstring

分配了网盘的用户 ID。

alice
GroupIdstring

团队空间 ID。

cg-i1ruuudp92qpj****
CdsIdstring

企业网盘 ID。

cn-hangzhou+cds-320357****
ParentFileIdstring

父文件 ID。可通过本接口的返回参数FileId获取。

63636837e47e5a24a8a940218bef395c210e****
FileIdsarray

需要查询的文件 ID 列表。

string

需要查询的文件 ID。

[\"635d3c12f70beed7b6f84a9bb7bd51aad910****\"]
OrderTypestring

文件列表排序方式。

枚举值:
  • CreateTimeDesc按创建时间降序排序
  • ModifiedTimeAsc按修改时间升序排序
  • NameDesc按文件名称降序排序
  • SizeAsc按文件大小升序排序
  • ModifiedTimeDesc按修改时间降序排序
  • CreateTimeAsc按创建时间升序排序
  • SizeDesc按文件大小降序排序
  • NameAsc按文件名称升序排序
CreateTimeDesc
Statusstring

文件状态。

枚举值:
  • available只返回正常文件
  • uploading只返回上传中的文件
available
NextTokenstring

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****
MaxResultsinteger

分页查询时,每页最大行数。默认值:100。

100
RegionIdstring

登录的地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询开始的 Token,NextToken为空表示没有下一个。

aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****
RequestIdstring

请求 ID。

40D86754-20FD-53DC-A9B8-25F7FECC****
Countstring

文件列表条目总数量。

2
Codestring

执行结果。返回success表示成功,否则将返回错误信息。

success
Messagestring

错误信息。当 Code 为success时,不返回该参数。

success
Successboolean

操作是否成功。

枚举值:
  • true成功
  • false失败
true
FileModelsarray<object>

文件列表。

object

文件信息。

ContentTypestring

文件内容类型。

application/json
FileTypestring

文件类型。

枚举值:
  • file文件
  • folder文件夹
file
FileExtensionstring

文件的后缀名。

pdf
FileIdstring

文件 ID。

637725ff2f63db8470984e6c92c692b87d52****
Creatorstring

文件的创建者。

demo_user01@cn-shanghai.148875033399****
OpenTimestring

最近一次打开文件的时间。

2022-09-06T07:27:08Z
ParentIdstring

父文件夹 ID。

3343213ff2f63db8470984e6c92c3213dfdw****
Modifierstring

修改者。

demo_user02@cn-shanghai.148875033399****
Descriptionstring

文件描述。

test1
Namestring

文件名称。

SampleFile.pdf
DownloadUrlstring

下载链接,默认有效时间是 15 分钟。

https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
Sha1string

数据文件的 SHA1 哈希值。

EA4942AA8761213890A5C386F88E6464D2C3****
OpenTimeStamplong

最后一次打开文件的时间戳。

168951245231
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-beijing
FilePathstring

文件路径。

isv/1019236948660053/temp/
Sizelong

文件大小。单位:Byte(字节)。

102400
Categorystring

文件类型分类。网盘会根据文件的后缀名和 MIME Type 对文件进行分了分类,主要分类有docimageaudiovideo

image
Md5string

文件 MD5 值。

63c83ececb4e6926c51448fc5ecb****
Thumbnailstring

缩略图地址。

https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
CreateTimestring

创建时间。

2022-09-06T07:27:08Z
ModifiedTimestring

最后一次修改文件的时间。

2022-09-06T07:27:08Z

示例

正常返回示例

JSON格式

{
  "NextToken": "aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****\n",
  "RequestId": "40D86754-20FD-53DC-A9B8-25F7FECC****",
  "Count": "2",
  "Code": "success",
  "Message": "success",
  "Success": true,
  "FileModels": [
    {
      "ContentType": "application/json",
      "FileType": "file",
      "FileExtension": "pdf",
      "FileId": "637725ff2f63db8470984e6c92c692b87d52****",
      "Creator": "demo_user01@cn-shanghai.148875033399****",
      "OpenTime": "2022-09-06T07:27:08Z",
      "ParentId": "3343213ff2f63db8470984e6c92c3213dfdw****\n",
      "Modifier": "demo_user02@cn-shanghai.148875033399****",
      "Description": "test1",
      "Name": "SampleFile.pdf",
      "DownloadUrl": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
      "Sha1": "EA4942AA8761213890A5C386F88E6464D2C3****",
      "OpenTimeStamp": 168951245231,
      "RegionId": "cn-beijing",
      "FilePath": "isv/1019236948660053/temp/",
      "Size": 102400,
      "Category": "image",
      "Md5": "63c83ececb4e6926c51448fc5ecb****",
      "Thumbnail": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
      "CreateTime": "2022-09-06T07:27:08Z",
      "ModifiedTime": "2022-09-06T07:27:08Z"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-29OpenAPI 入参发生变更查看变更详情
2023-05-16API 内部配置变更,不影响调用查看变更详情