文档首页/ AI科学计算服务/ API参考/ API/ 数据管理/ OBS桶管理/ 获取用户OBS桶内对象 - ListObsBucketObject
更新时间:2025-12-26 GMT+08:00
分享

获取用户OBS桶内对象 - ListObsBucketObject

功能介绍

获取用户OBS桶内对象。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/customer-buckets/{bucket_name}/objects

表1 路径参数

参数

是否必选

参数类型

描述

bucket_name

是

String

参数解释:

桶名称。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和点,长度为[1-128]个字符。

默认取值:

不涉及

project_id

是

String

参数解释:

项目ID,您可以从获取项目ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

限制量,单次查询总量[1,1000],默认100。

约束限制:

不涉及

取值范围:

整数,范围为[1-1000]。

默认取值:

100

offset

否

Integer

参数解释:

偏移量,查询起始偏移,默认为0。

约束限制:

不涉及

取值范围:

整数,范围为[0-100000000]。

默认取值:

0

path

否

String

参数解释:

子路径。

约束限制:

不涉及

取值范围:

长度为[0-2000]个字符。

默认取值:

不涉及

search_key

否

String

参数解释:

查询关键词。

约束限制:

不涉及

取值范围:

长度为[0-2000]个字符。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及

取值范围:

长度为[1-32768]个字符。

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

数据(文件夹、文件)总数量。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

objects

Array of BucketObjectDto objects

参数解释:

数据列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 BucketObjectDto

参数

参数类型

描述

path

String

参数解释:

对象全路径(桶名称:/路径)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

对象名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

type

String

参数解释:

路径类型:文件、目录。

约束限制:

不涉及

取值范围:

  • FILE:文件

  • FOLDER:目录

默认取值:

不涉及

size

Long

参数解释:

对象大小。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

create_time

String

参数解释:

创建时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

获取用户OBS桶内对象。

https://{endpoint}/v1/{project_id}/customer-buckets/{bucket_name}/object

响应示例

状态码:200

OK

{
  "count" : 1,
  "objects" : [ {
    "path" : "bucket:/test.txt",
    "name" : "test.txt",
    "type" : "FILE",
    "size" : 1024,
    "create_time" : "2021-02-01T14:25:34Z"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档