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

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:ListCdsFiles

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

EndUserId

string

分配了网盘的用户 ID。

alice

GroupId

string

团队空间 ID。

cg-i1ruuudp92qpj****

CdsId

string

企业网盘 ID。

cn-hangzhou+cds-320357****

ParentFileId

string

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

63636837e47e5a24a8a940218bef395c210e****

FileIds

array

需要查询的文件 ID 列表。

string

需要查询的文件 ID。

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

OrderType

string

文件列表排序方式。

枚举值:

  • CreateTimeDesc :

    按创建时间降序排序

  • ModifiedTimeAsc :

    按修改时间升序排序

  • NameDesc :

    按文件名称降序排序

  • SizeAsc :

    按文件大小升序排序

  • ModifiedTimeDesc :

    按修改时间降序排序

  • CreateTimeAsc :

    按创建时间升序排序

  • SizeDesc :

    按文件大小降序排序

  • NameAsc :

    按文件名称升序排序

CreateTimeDesc

Status

string

文件状态。

枚举值:

  • available :

    只返回正常文件

  • uploading :

    只返回上传中的文件

available

NextToken

string

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

aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****

MaxResults

integer

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

100

RegionId

string

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

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

NextToken

string

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

aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****

RequestId

string

请求 ID。

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

Count

string

文件列表条目总数量。

2

Code

string

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

success

Message

string

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

success

Success

boolean

操作是否成功。

枚举值:

  • true :

    成功

  • false :

    失败

true

FileModels

array<object>

文件列表。

object

文件信息。

ContentType

string

文件内容类型。

application/json

FileType

string

文件类型。

枚举值:

  • file :

    文件

  • folder :

    文件夹

file

FileExtension

string

文件的后缀名。

pdf

FileId

string

文件 ID。

637725ff2f63db8470984e6c92c692b87d52****

Creator

string

文件的创建者。

demo_user01@cn-shanghai.148875033399****

OpenTime

string

最近一次打开文件的时间。 时间格式为 ISO 8601 标准的 UTC 时间:yyyy-MM-ddTHH:mm:ssZ。

2022-09-06T07:27:08Z

ParentId

string

父文件夹 ID。

3343213ff2f63db8470984e6c92c3213dfdw****

Modifier

string

修改者。

demo_user02@cn-shanghai.148875033399****

Description

string

文件描述。

test1

Name

string

文件名称。

SampleFile.pdf

DownloadUrl

string

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

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

Sha1

string

数据文件的 SHA1 哈希值。

EA4942AA8761213890A5C386F88E6464D2C3****

OpenTimeStamp

integer

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

168951245231

RegionId

string

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

cn-beijing

FilePath

string

文件路径。

isv/1019236948660053/temp/

Size

integer

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

102400

Category

string

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

image

Md5

string

文件 MD5 值。

63c83ececb4e6926c51448fc5ecb****

Thumbnail

string

缩略图地址。

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

CreateTime

string

创建时间。 时间格式为 ISO 8601 标准的 UTC 时间:yyyy-MM-ddTHH:mm:ssZ。

2022-09-06T07:27:08Z

ModifiedTime

string

最后一次修改文件的时间。 时间格式为 ISO 8601 标准的 UTC 时间:yyyy-MM-ddTHH:mm:ssZ。

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"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情