更新时间:2024-05-09 GMT+08:00
分享

获取用户OBS桶内对象

功能介绍

获取用户OBS桶内对象

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

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://eihealth.cn-north-4.myhuaweicloud.com/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

错误码

请参见错误码

相关文档