查询文件夹和文件信息
功能介绍
查询指定目录下文件夹和文件信息
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/cloud-storages/actions/list-folder-files
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_name |
是 |
String |
用户名 |
|
cloud_storage_assignment_id |
否 |
String |
个人文件夹ID。(用户拥有多个文件夹时,如果不传个人文件夹id则选择最早创建的文件系统进行文件查询) |
|
folder_url |
是 |
String |
查询文件夹路径 |
|
marker |
否 |
String |
指定一个标识符,从该标识符以后按文件名的字典顺序返回文件列表。 |
|
limit |
否 |
Integer |
列举文件系统的最大数目,返回的文件系统列表将是按照字典顺序的最多前 limit 个,默认取值为1000。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
location |
String |
文件系统所在区域代号。 |
|
prefix |
String |
文件名的绝对路径的前缀。 |
|
files |
Array of FileInfo objects |
文件信息列表。 |
|
folders |
Array of FolderInfo objects |
文件夹信息列表。 |
|
marker |
String |
本次列举的文件的起始位置,默认为空。 |
|
next_marker |
String |
下次列举请求的的起始位置,默认为空。 |
|
max_keys |
Integer |
本次列举可以返回的最大文件数量,非本次列举返回的数量,取入参与系统默认值的小值为准。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET /v1/a4da8115c9d8464ead3a38309130523f/cloud-storages/actions/list-folder-files
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应。 |
|
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。