Updated on 2026-09-22 GMT+08:00

Listing Buckets

If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see API Reference.

You can call ObsClient->listBuckets to list buckets. Sample code is as follows:

<?php

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with the source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
use Obs\ObsException;
// Create an ObsClient instance.
$obsClient = new ObsClient([ 
    // Obtain an AK/SK pair using environment variables (recommended) or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    'key' => getenv('ACCESS_KEY_ID'),
    'secret' => getenv('SECRET_ACCESS_KEY'),
    'endpoint' => 'https://your-endpoint',
]);

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 (ObsException $e) {
      // If the operation fails, obtain the exception details.
      printf("ListBucketsFailed: Status:%d, Code:%s, Message:%s\n",
        $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
      // Close ObsClient to release resources.
      $obsClient->close();
}
  • Obtained bucket names are listed in the lexicographical order.
  • If QueryLocation is set to true, the bucket listing results will include the location of each bucket (including common buckets and parallel file systems).