ListFiles - 查询文件列表_视图计算(VECS)-阿里云帮助中心

查询上传的文件列表，返回内容包含文件的上传状态，支持分页查询。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vs:ListFiles	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
FileId	string	否	文件 ID，对应唯一的可用文件	f-1671accd4dafdag3er256cvgewt13f7141db2f7
FileName	string	否	文件名	myfile
PageNumber	long	否	查询列表的页码。起始值为 1。默认值：1	1
PageSize	long	否	分页查询时设置的每页行数，取值范围 1～100。默认值：10	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	BEA5625F-8FCF-48F4-851B-CA63946DA664
Files	array<object>	文件信息列表
Files	object	文件信息
FileId	string	文件 ID	f-1671accd4dafdag3er256cvgewt13f7141db2f7
FileName	string	文件名	myfile
TargetPath	string	向云应用服务实例推送的目标路径	/data/tmp/test/xxx.tar
Description	string	文件描述信息	我的文件
Status	string	文件上传状态，取值范围： Created Doing Success：终态 Failed：终态	Success
UploadTime	string	上传开始时间	2024-03-28T14:10:12+08:00
UpdateTime	string	状态最新更新时间	2024-03-28T14:15:08+08:00
StatusDescription	string	状态描述信息	upload success
TotalCount	long	匹配的文件记录总数	200
PageNumber	long	查询列表的页码	1
PageSize	long	分页查询时设置的每页行数	10

示例

正常返回示例

JSON格式

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Files": [
    {
      "FileId": "f-1671accd4dafdag3er256cvgewt13f7141db2f7",
      "FileName": "myfile",
      "TargetPath": "/data/tmp/test/xxx.tar",
      "Description": "我的文件",
      "Status": "Success",
      "UploadTime": "2024-03-28T14:10:12+08:00",
      "UpdateTime": "2024-03-28T14:15:08+08:00",
      "StatusDescription": "upload success"
    }
  ],
  "TotalCount": 200,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

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