文档首页/ 云容器引擎 CCE/ API参考/ 历史API/ 存储管理/ 获取obs桶详情(待废弃) - GetBucket
更新时间:2025-12-19 GMT+08:00
分享

获取obs桶详情(待废弃) - GetBucket

功能介绍

该API用于获取用户的obs桶详情。

调用方法

请参见如何调用API

授权信息

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

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

URI

GET /api/v3.1/storage/obs/buckets/{bucket_name}

表1 路径参数

参数

是否必选

参数类型

描述

bucket_name

String

参数解释

桶名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Cluster-ID

String

集群ID,使用https://Endpoint/uri这种URL格式时必须指定此参数。获取方式请参见如何获取接口URI中参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

name

String

参数解释:

桶名称

取值范围:

不涉及

storage_class

String

参数解释:

桶类型

取值范围:

不涉及

region

String

参数解释:

桶所在可用区

取值范围:

不涉及

obs_fs_file_interface

Boolean

参数解释:

是否为并行文件系统

取值范围:

  • true:并行文件系统

  • false:非并行文件系统

epid

String

参数解释:

企业项目ID

取值范围:

不涉及

obs_bucket_redundancy

String

参数解释:

桶冗余

取值范围:

不涉及

请求示例

获取用户的obs桶详情

GET /api/v3.1/storage/obs/buckets/{bucket_name}

{
  "name" : "cce-charts-cn-north-7-2c8ac3fe69c540919820dd679733d82e",
  "storage_class" : "standard",
  "region" : "cn-north-7",
  "obs_fs_file_interface" : false,
  "epid" : "0",
  "obs_bucket_redundancy" : ""
}

响应示例

状态码:200

表示获取用户的obs桶详情成功

{
  "name" : "cce-charts-cn-north-7-2c8ac3fe69c540919820dd679733d82e",
  "storage_class" : "standard",
  "region" : "cn-north-7",
  "obs_fs_file_interface" : false,
  "epid" : "0",
  "obs_bucket_redundancy" : ""
}

状态码

状态码

描述

200

表示获取用户的obs桶详情成功

错误码

请参见错误码

相关文档