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

查询OBS桶对象列表 - ListObsObject

功能介绍

查询OBS桶对象列表。

调试

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

授权信息

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

URI

GET /v1/{project_id}/obs/buckets/{bucket_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

bucket_name

是

String

OBS桶名称。只能包含字母、数字和._-特殊字符，且长度为1到64个字符。
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

查询起始object名称。最大长度为4096个字符。

limit

是

Integer

查询返回条数。最小值为1，最大值为1000。

prefix

否

String

搜索前缀。最大长度为4096个字符。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

租户token。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

object_names

Array of strings

object名称列表。

file_names

Array of strings

obs文件名称列表

location

String

region编码。

prefix

String

搜索前缀。

bucket_name

String

OBS桶名称。

next_marker

String

下一个object起始位置。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error

Error object

错误信息。

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。
表8 Error

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。

message

String

错误信息。

code

String

状态码。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码：408

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

请求示例

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

响应示例

状态码：200

查询OBS桶对象列表响应体

{
  "object_names" : [ "aaa/", "test/" ],
  "file_names" : [ "test1.doc", "test2.jar" ],
  "location" : "xxxxxx",
  "prefix" : "",
  "bucket_name" : "lakeformation",
  "next_marker" : "next"
}

状态码：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管理

相关文档