文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据水印/ 获取当前桶的文件信息 - ShowBucketFiles
更新时间:2026-10-09 GMT+08:00
分享

获取当前桶的文件信息 - ShowBucketFiles

功能介绍

功能介绍:获取当前桶的文件信息

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/watermark/bucket-files

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

bucket_name

是

String

参数解释:

桶名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

否

Integer

参数解释:

分页大小

约束限制:

不涉及

取值范围:

不涉及

默认取值:

100

only_folder

否

Boolean

参数解释:

是否只显示文件夹

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

marker

否

String

参数解释:

分页标记

约束限制:

不涉及

取值范围:

不涉及

默认取值:

空字符串

prefix

否

String

参数解释:

前缀过滤

约束限制:

不涉及

取值范围:

不涉及

默认取值:

空字符串

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

next_marker

String

参数解释:

下一页查询标记

取值范围:

不涉及

files

Array of ObsFile objects

参数解释:

文件信息列表

取值范围:

不涉及

file_name

String

参数解释:

文件名称

取值范围:

不涉及

sensitive_level_name

String

参数解释:

敏感级别名称

取值范围:

不涉及

is_truncated

Boolean

参数解释:

是否截断

取值范围:

true-是,false-否

is_folder

Boolean

参数解释:

是否文件夹

取值范围:

true-是,false-否

表5 ObsFile

参数

参数类型

描述

file_name

String

参数解释:

文件名

取值范围:

不涉及

is_folder

Boolean

参数解释:

是否为文件夹

取值范围:

true-是,false-否

sensitive_level_name

String

参数解释:

敏感级别名称

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "next_marker" : "marker-cursor-9f2a3b4c",
  "files" : [ {
    "file_name" : "financial-report.pdf",
    "is_folder" : false,
    "sensitive_level_name" : "高敏感"
  } ],
  "file_name" : "financial-report.pdf",
  "sensitive_level_name" : "高敏感",
  "is_truncated" : false,
  "is_folder" : false
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档