获取桶列表-ListBuckets
功能介绍
OBS用户可以通过请求查询自己创建的所有区域的桶列表。
接口约束
- 终端节点（Endpoint）不会限制查询结果，无论哪一个区域的Endpoint，查询结果都是所有区域的桶列表。
- 创建桶时，请勿并发列举桶。
请求消息样式
1 2 3 4 |
GET / HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Date: date Authorization: authorization |
请求消息参数
该请求消息中不带请求参数。
请求消息头
该操作消息头与普通请求一样，请参见表1，但可以带附加消息头，附加请求消息头如下所示。
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-obs-bucket-type |
否 |
String |
参数解释： 此消息头明确获取桶列表的内容，即列表中包含什么类型的桶。 示例：x-obs-bucket-type: 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，否则无法列出桶。 取值范围： 无 默认取值： 无 |
请求消息元素
该请求消息中不带请求元素。
响应消息样式
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
GET HTTP/1.1 status_code Content-Type: type Date: date Content-Length: length <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ListAllMyBucketsResult xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <Owner> <ID>id</ID> </Owner> <Buckets> <Bucket> <Name>bucketName</Name> <CreationDate>date</CreationDate> <Location>region</Location> <BucketType>buckettype</BucketType> <IESLocation>ies az id</IESLocation> <EdgeLocation>iec az id</EdgeLocation> </Bucket> ... </Buckets> </ListAllMyBucketsResult> |
响应消息头
该请求的响应消息使用公共消息头，具体请参考表1。
响应消息元素
该请求的响应消息中，会以XML形式将用户拥有的桶列出来，元素的具体含义如表2所示。
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ListAllMyBucketsResult |
XML |
参数解释： 取值范围： 不涉及 |
|
XML |
参数解释： 桶拥有者信息。 取值范围： 请详见Owner参数说明。 |
|
|
XML |
参数解释： 本次列举返回的桶列表。 取值范围： 请详见Buckets参数说明。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
Name |
String |
参数解释： 桶名。 取值范围： 长度为3～63的字符串。 |
|
CreationDate |
String |
参数解释： 桶的创建时间（UTC时间）。日期格式为ISO8601的格式，例如：2025-06-28T08:57:41.047Z。 取值范围： 长度为24的字符串。 |
|
Location |
String |
参数解释： 桶所在的区域。 取值范围： 当前有效的OBS区域位置和终端节点的更多信息，请参考地区和终端节点。 |
|
BucketType |
String |
参数解释： 桶类型。 取值范围：
|
|
IESLocation |
String |
CloudPond桶所在站点的AZ Id。非CloudPond的桶不存在此标签。 类型：String 父节点：Bucket |
|
EdgeLocation |
String |
智能边缘云的桶所在站点的AZ Id。非智能边缘云的桶不存在此标签。 类型：String 父节点：Bucket |
错误响应消息
该请求无特殊错误，所有错误已经包含在表2中。
请求示例
1 2 3 4 5 6 7 |
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= |
响应示例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
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 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ListAllMyBucketsResult xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <Owner> <ID>783fc6652cf246c096ea836694f71855</ID> </Owner> <Buckets> <Bucket> <Name>examplebucket01</Name> <CreationDate>2018-06-21T09:15:01.032Z</CreationDate> <Location>cn-north-4</Location> <BucketType>OBJECT</BucketType> <IESLocation>ies az id</IESLocation> <EdgeLocation>iec az id</EdgeLocation> </Bucket> <Bucket> <Name>examplebucket02</Name> <CreationDate>2018-06-22T03:56:33.700Z</CreationDate> <Location>cn-east-3</Location> <BucketType>OBJECT</BucketType> <IESLocation>ies az id</IESLocation> <EdgeLocation>iec az id</EdgeLocation> </Bucket> </Buckets> </ListAllMyBucketsResult> |
