# 获取桶列表-ListBuckets
#### 功能介绍
OBS用户可以通过本接口查询自己创建的所有区域的桶列表。了解更多获取桶列表相关信息，请参见[列举桶](https://support.huaweicloud.com/usermanual-obs/obs_41_0010.html)。
#### 接口约束
- 终端节点（Endpoint）不会限制查询结果，无论哪一个区域的Endpoint，查询结果都是所有区域的桶列表。
- 创建桶时，请勿并发列举桶。
#### 授权信息
账号根用户具备所有API的调用权限，账号的其他IAM用户需拥有列举桶的权限才能调用当前API，建议使用IAM进行授权。请在"角色与策略授权"、"身份策略授权"两种IAM授权方式中选择一种，并配置相应权限：
- 如果使用**角色与策略授权** （旧版IAM，即IAM v3接口），需具备**obs:bucket:ListAllMyBuckets** 权限，授权操作请参见[创建IAM自定义策略](https://support.huaweicloud.com/usermanual-iam/iam_01_0605.html)。
- 如果使用**身份策略授权** （新版IAM，即IAM v5接口），如下表所示，需具备**obs:bucket:listAllMyBuckets** 权限，授权操作请参见[创建IAM自定义身份策略](https://support.huaweicloud.com/usermanual-iam5/iam_01_0917.html)。
| 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | [条件键](https://support.huaweicloud.com/api-obs/obs_04_0112.html#ZH-CN_TOPIC_0000002375307974__condition_table) Condition Key | [别名](https://support.huaweicloud.com/iam5_faq/iam_01_1103.html) Alias | 依赖的授权项 Dependencies |
|:---|:---|:---|:---|:---|:---|
| obs:bucket:listAllMyBuckets | List | bucket \* | - | - | - |
| obs:bucket:listAllMyBuckets | List | - | - obs:EpochTime - obs:SourceIp - obs:TlsVersion - obs:CustomDomain | - | - |
#### URI
GET /
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-obs/obs_04_0006.html)。调用前需要先[计算API签名](https://support.huaweicloud.com/api-obs/obs_04_0009.html)，并将签名添加到请求中。
您还可以使用[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/OBS/doc?api=ListBuckets)在线调试接口。
#### 请求消息样式
*RegionID* 不会限制查询结果，无论填写哪一个区域ID，查询结果都是所有区域的桶列表，可从[支持区域](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)中获取区域ID。
```
GET / HTTP/1.1
Host: obs.RegionID.myhuaweicloud.com
Date: GMT Date
Authorization: SignatureValue
```
#### URI参数（URI Parameters）
本接口的请求消息不带URI参数。
#### 请求头参数（Request headers）
本接口请求头包括公共请求头和附加请求头，公共请求头参见[表1]，附加请求头如下所示。
表1请求头参数
| 参数 | **是否必选** | **参数类型** | **描述** |
|:---|:---|:---|:---|
| x-obs-bucket-type | 否 | String | **参数解释：** 此消息头明确获取桶列表的内容，即列表中包含什么类型的桶。 示例：x-obs-bucket-type: POSIX **约束限制：** 不带此消息头则获取所有桶和并行文件系统列表。 **取值范围**： - OBJECT：获取所有对象桶列表。 - POSIX：获取所有并行文件系统列表。 **默认取值**： 不带请求头场景：默认取值为空，表示OBJECT和POSIX同时携带。 |
| x-obs-ies-location | 否 | String | **参数解释：** 通过此头域可以列举指定AZ Id的CloudPond站点的桶，普通桶不返回。如果对应CloudPond站点下没有桶或者没有对应CloudPond站点，则列举桶返回空。 示例：x-obs-ies-location:AZ1 **约束限制：** 必须携带合法的CloudPond站点的AZ Id，否则无法列出桶。 **取值范围：** 不涉及 **默认取值**： 不涉及 |
| x-obs-edge-location | 否 | String | **参数解释：** 通过此头域可以列举指定AZ Id的智能边缘云站点的桶，普通桶不返回。如果对应智能边缘云站点下没有桶或者没有对应智能边缘云站点，则列举桶返回空。 示例：x-obs-edge-location:AZ1 **约束限制：** 必须携带合法的智能边缘云站点的AZ Id，否则无法列出桶。 **取值范围：** 不涉及 **默认取值**： 不涉及 |
#### 请求体参数（Request body）
该请求消息中不带请求体参数。
#### 响应消息样式
```
HTTP/1.1 status_code
Content-Type: type
Date: GMT Date
Content-Length: BodyLength
DomainID
BucketName
GMTDate
RegionID
buckettype
ies az id
iec az id
...
```
#### 响应头 (Response Headers)
该请求的响应消息使用公共响应头，具体请参考[表1](https://support.huaweicloud.com/api-obs/obs_04_0013.html#ZH-CN_TOPIC_0173612084__d0e686)。
#### 响应体 (Response Body)
该请求的响应体中，会以XML形式将用户拥有的桶列出来，元素的具体含义如[表2]所示。
表2响应体
| 参数 | **参数类型** | **描述** |
|:---|:---|:---|
| ListAllMyBucketsResult | XML | **参数解释：** 用户的桶列表，是[Owner]和[Buckets]的父节点。 |
| [Owner] | XML | **参数解释：** 桶拥有者信息，该参数的相关信息请参见[Owner参数说明]。 |
| [Buckets] | XML | **参数解释：** 本次列举返回的桶列表，该参数的相关信息请参见[Buckets参数说明]。 |
表3Owner参数说明
| **参数** | **参数类型** | **描述** |
|:---|:---|:---|
| ID | String | **参数解释：** 桶拥有者的DomainID（账号ID）。 **取值范围：** 请详见[DomainID（账号ID）](https://support.huaweicloud.com/api-obs/obs_04_0117.html)。 |
表4Buckets参数说明
| **参数** | **参数类型** | **描述** |
|:---|:---|:---|
| [Bucket] | XML | **参数解释：** 具体的桶信息，包含桶名、桶创建时间等参数，该参数相关信息请参见请参见[Bucket参数说明]。 |
表5Bucket参数说明
| **参数** | **参数类型** | **描述** |
|:---|:---|:---|
| Name | String | **参数解释** **：** 桶名。 **取值范围：** 长度为3～63的字符串。 |
| CreationDate | String | **参数解释** **：** 桶的创建时间（UTC时间）。日期格式为ISO8601的格式，例如：2025-06-28T08:57:41.047Z。 **取值范围：** 长度为24的字符串。 |
| Location | String | **参数解释** **：** 桶所在的区域。 **取值范围：** 当前有效的OBS区域位置和终端节点的更多信息，请参考[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 |
| BucketType | String | **参数解释** **：** 桶类型。 **取值范围：** - OBJECT：对象存储桶。 - POSIX：并行文件系统。 |
| IESLocation | String | **参数解释：** CloudPond桶所在站点的AZ Id。非CloudPond的桶不存在此标签。 父节点：Bucket **取值范围：** 不涉及 |
| EdgeLocation | String | **参数解释：** 智能边缘云的桶所在站点的AZ Id。非智能边缘云的桶不存在此标签。 父节点：Bucket **取值范围：** 不涉及 |
#### 错误响应消息
该请求无特殊错误，所有错误已经包含在[错误码概述](https://support.huaweicloud.com/api-obs/obs_04_0115.html)中。
#### 请求示例
```
GET / HTTP/1.1
User-Agent: curl/7.29.0
Host: obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: Mon, 25 Jun 2018 05:37:12 +0000
Authorization: OBS GKDF4C7Q6SI0IPGTXTJN:9HXkVQIiQKw33UEmyBI4rWrzmic=
```
#### 响应示例
```
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016435722C11379647A8A00A
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSGGDRUM62QZi3hGP8Fz3gOloYCfZ39U
Content-Type: application/xml
Date: Mon, 25 Jun 2018 05:37:12 GMT
Content-Length: 460
783fc6652cf246c096ea836694f71855
examplebucket01
2018-06-21T09:15:01.032Z
cn-north-4
OBJECT
ies az id
iec az id
examplebucket02
2018-06-22T03:56:33.700Z
cn-east-3
OBJECT
ies az id
iec az id
```
#### 使用SDK调用接口
建议您使用OBS SDK调用接口。SDK对API进行了封装以简化您的开发工作，直接调用SDK接口函数即可访问OBS，无需手动计算签名。
| [Java](https://support.huaweicloud.com/sdk-java-devg-obs/obs_21_0402.html) | [Python](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_0802.html) | [C](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0302.html) | [Go](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0403.html) | BrowserJS不支持列举桶。 | [.NET](https://support.huaweicloud.com/sdk-dotnet-devg-obs/obs_25_0302.html) | [Android](https://support.huaweicloud.com/sdk-android-devg-obs/obs_26_0302.html) | [iOS](https://support.huaweicloud.com/sdk-ios-devg-obs/obs_27_0302.html) | [PHP](https://support.huaweicloud.com/sdk-php-devg-obs/obs_28_0302.html) | [Node.js](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0302.html) |
|---|---|---|---|---|---|---|---|---|---|
#### 相关文档
- 使用obsutil获取桶列表，请参见[列举桶](https://support.huaweicloud.com/utiltg-obs/obs_11_0009.html)。
- 了解更多获取桶列表相关信息，请参见[列举桶](https://support.huaweicloud.com/usermanual-obs/obs_41_0010.html)。
- API操作涉及的计费项参见[计费项](https://support.huaweicloud.com/price-obs/obs_42_0002.html)。