更新时间:2024-06-28 GMT+08:00
分享

列举目录下文件

功能介绍

列举存储中某目录下文件。

URI

GET AstroZero域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/listdir?dir=path&max-keys=A&marker=B

表1 路径参数

参数

是否必选

参数类型

描述

connector_type

String

参数解释

连接器的类型。

约束限制

不涉及。

取值范围

  • obs:与OBS对接的连接器。
  • minio:与MINIO对接的连接器。
  • objectstorageproxy:对象存储代理类型。

默认取值

不涉及。

connector_name

String

参数解释

连接器实例的名称,即创建连接器时设置的连接器实例名。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

dir

String

参数解释

要列举的目录,如果目录为空或者“/ ”,则代表列举根目录。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

max-keys

Number

参数解释

最大访问文件个数,最大支持1000个,缺省值为“1000”。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

marker

String

参数解释

起始访问位置文件,注意起始位置文件并不会包含到返回结果中,且起始访问文件必须是全路径的,即包含目录。 如果不指定,则从头开始。

示例:marker=a/b/c/1.txt。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

表2 响应参数说明

参数

参数类型

描述

resCode

String

参数解释

返回码。

取值范围

如果返回“0”代表请求成功,其他错误码说明请参考错误码

resMsg

String

参数解释

返回消息。

取值范围

如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。

result

Array of objects

参数解释

返回目录的文件列表,列表中元素字段含义如下:

  • name:文件名或目录路径。
  • isDir:是否为目录。
  • size:文件大小。

请求示例

已创建好OBS类型连接器,连接器实例名称为“命名空间__TestOBS”,执行如下请求,列举OBS桶中“a/b/c”路径下文件,起始文件为“1.txt”。

GET https://AstroZero域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/listdir?dir=a/b/c&max-keys=1000&marker=a/b/c/1.txt

响应示例

{
	"resCode": "0",
	"resMsg": "成功",
	"result": [{
			"name": "test.zip",
			"isDir": false,
			"size": 833154
		},
		{
			"name": "图片_20201220181511.png",
			"isDir": false,
			"size": 78530
		},
		{
			"name": "月度总结.txt",
			"isDir": false,
			"size": 824
		}
	]
}

状态码

状态码请参见状态码

错误码

错误码请参见错误码

相关文档