Help Center/OBS PHP SDK/API Reference/Bucket-Related APIs/GET Buckets
Updated on 2025-12-04 GMT+08:00
View PDF

GET Buckets

API Description

You can use this API to obtain the bucket list. In the list, bucket names are displayed in lexicographical order.

Method Definition

1. ObsClient->listBuckets(array $parameter)
2. ObsClient->listBucketsAsync(array $parameter, callable $callback)

Request Parameter

Field

Type

Optional or Mandatory

Description

QueryLocation

boolean

Optional

Whether to query the bucket location

Returned Result

Field

Type

Description

HttpStatusCode

integer

HTTP status code

Reason

string

Reason description

RequestId

string

Request ID returned by the OBS server

Buckets

indexed array

List of buckets

-

Name

string

Bucket name

CreationDate

string

Time when the bucket is created

Location

string

Bucket location

Owner

associative array

Bucket owner

-

ID

string

ID of the domain to which the bucket owner belongs

Sample Code

try{
       $resp = $obsClient -> listBuckets([
             'QueryLocation' => true
       ]);
       printf("RequestId:%s\n", $resp['RequestId']);
       printf("Owner[ID]:%s\n", $resp['Owner']['ID']);
       
       foreach ($resp['Buckets'] as $index => $bucket){
              printf("Buckets[%d]\n", $index + 1);
              printf("Name:%s\n", $bucket['Name']);
              printf("CreationDate:%s\n", $bucket['CreationDate']);
              printf("Location:%s\n", $bucket['Location']);
       }
}catch (Obs\Common\ObsException $obsException){
       printf("ExceptionCode:%s\n", $obsException->getExceptionCode());              
       printf("ExceptionMessage:%s\n", $obsException->getExceptionMessage());
}
Parent topic:Bucket-Related APIs