Listing Buckets

Updated on 2024-01-02 GMT+08:00

View PDF

Functions

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

Request Syntax

GET / HTTP/1.1 
Host: obs.region.example.com
Date: date
Authorization: authorization

Request Parameters

This request contains no parameters.

Request Headers

The operation message header is the same as that of a common request. For details, see Table 3. However, this request can contain additional headers. The following table describes the additional headers for this request.

**Table 1** Additional request headers
Header	Description	Mandatory
x-obs-bucket-type	This header field is used to specify the content to be obtained. Value: OBJECT: Obtain the list of all buckets. POSIX: Obtain the list of all parallel file systems. If this header is not carried, the list of all buckets and parallel file systems is obtained. Type: string Example: x-obs-bucket-type: POSIX	No

Request Elements

The request does not use request elements.

Response Syntax

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>
        </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 2 describes the elements.

**Table 2** 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

Error Responses

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

Sample Request

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

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>
    </Bucket>
    <Bucket>
      <Name>examplebucket02</Name>
      <CreationDate>2018-06-22T03:56:33.700Z</CreationDate>
      <Location>region</Location>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

Parent topic: Operations on Buckets

Previous topic: Operations on Buckets

Next topic: Creating a Bucket

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot