doc-exports/docs/obs/api-ref/obs_04_0020.html
Jawei, Li f1cb839979 OBS api-ref 2.0.38.SP5
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Jawei, Li <lijiawei5@huawei.com>
Co-committed-by: Jawei, Li <lijiawei5@huawei.com>
2022-11-03 11:54:51 +00:00

11 KiB

Listing Buckets

Functions

You can perform this operation to list all buckets that you have created.

Request Syntax

1
2
3
4
GET / HTTP/1.1 
Host: obs.region.example.com
Date: date
Authorization: authorization

Request Parameters

This request contains no parameter.

Request Headers

This request header uses common message fields. For details, see Table 3.

Request Elements

The request does not use request elements.

Response Syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
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.region.example.com/doc/2015-06-30/">
    <Owner> 
        <ID>id</ID>
    </Owner> 
    <Buckets>
        <Bucket> 
            <Name>bucketName</Name> 
            <CreationDate>date</CreationDate>
            <Location>region</Location>
            <BucketType>buckettype</BucketType>
        </Bucket> 
        ... 
    </Buckets> 
</ListAllMyBucketsResult> 

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

This response contains the XML list of buckets owned by the user. Table 1 describes the elements.

Table 1 Response elements

Element

Description

ListAllMyBucketsResult

List of buckets created by the user

Type: XML

Owner

Bucket owner information, including the tenant ID.

Type: XML

ID

Domain ID (account ID) of a user.

Type: string

Buckets

Buckets owned by the user

Type: XML

Bucket

Details about a bucket

Type: XML

Name

Bucket name

Type: string

CreationDate

Creation time of the bucket

Type: string

Location

Location of the bucket

Type: string

BucketType

Bucket type

Type: string. Value options are as follows:

  • OBJECT: indicates a bucket.

Error Responses

No special error responses are involved. For details about error responses, see Table 2.

Sample Request

1
2
3
4
5
6
GET / HTTP/1.1
User-Agent: curl/7.29.0
Host: obs.region.example.com
Accept: */*
Date: Mon, 25 Jun 2018 05:37:12 +0000
Authorization: OBS GKDF4C7Q6SI0IPGTXTJN:9HXkVQIiQKw33UEmyBI4rWrzmic= 

Sample Response

 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
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.example.com/doc/2015-06-30/">
  <Owner>
    <ID>783fc6652cf246c096ea836694f71855</ID>
  </Owner>
  <Buckets>
    <Bucket>
      <Name>examplebucket01</Name>
      <CreationDate>2018-06-21T09:15:01.032Z</CreationDate>
      <Location>region</Location>
      <BucketType>OBJECT</BucketType>
    </Bucket>
    <Bucket>
      <Name>examplebucket02</Name>
      <CreationDate>2018-06-22T03:56:33.700Z</CreationDate>
      <Location>region</Location>
      <BucketType>OBJECT</BucketType>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>