文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ Console类API/ OBS管理/ 查询OBS桶列表 - ListObsBuckets
更新时间：2026-08-11 GMT+08:00
查看PDF
分享

查询OBS桶列表 - ListObsBuckets

功能介绍

查询OBS桶列表。

调试

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

授权信息

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

URI

GET /v1/{project_id}/obs/buckets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目编号。获取方法，请参见获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

bucket_type

否

String

参数解释:

PFS：并行文件系统

OBJECT：对象存储桶

约束限制:

最小长度为1，可选值为：PFS, OBJECT, name: offset

取值范围:

最小长度为1

默认取值:

不涉及

offset

否

Integer

参数解释:

分页查询时的偏移量。默认值为0。最小值为1，最大值为1000

约束限制:

取值为0~1000

取值范围:

取值为0~1000

默认取值:

0

limit

否

Integer

参数解释:

分页一页显示数。默认值为1000。最小值为1，最大值为1000

约束限制:

取值为1~1000

取值范围:

取值为1~1000

默认取值:

100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释:

租户token

约束限制:

长度为0~65534个字符

取值范围:

长度为0~65534个字符

默认取值:

不涉及

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID，定位辅助信息。
表5 响应Body参数

参数

参数类型

描述

buckets

Array of BucketDetail objects

参数解释:

OBS桶列表

total

Integer

参数解释:

OBS桶总数
表6 BucketDetail

参数

参数类型

描述

id

String

参数解释:

OBS桶ID

name

String

参数解释:

OBS桶名称

creation_date

String

参数解释:

OBS桶创建时间

location

String

参数解释:

所属region

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：403

表9 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

错误信息

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题
表10 Error

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题

message

String

参数解释:

错误信息

code

String

参数解释:

状态码

状态码：404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：408

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

请求示例

GET https://{endpoint}/v1/{project_id}/obs/buckets

响应示例

状态码：200

OBS桶列表

{
  "total" : 3,
  "buckets" : [ {
    "id" : "555d9e8999c94705be3d7edb70a3199a",
    "name" : "lakeformation",
    "creation_date" : "2022-06-01T09:32:01.487+00:00",
    "location" : "xxxxxx"
  }, {
    "id" : "555d9e8999c94705be3d7edb70a3199a",
    "name" : "lakeformation-test",
    "creation_date" : "2022-06-07T03:20:39.120+00:00",
    "location" : "xxxxxx"
  }, {
    "id" : "555d9e8999c94705be3d7edb70a3199a",
    "name" : "test-bk",
    "creation_date" : "2022-08-02T09:36:37.193+00:00",
    "location" : "xxxxxx"
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OBS桶列表

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： OBS管理

相关文档