All Products
Document Center

Object Storage Service:Query information about a bucket by using OSS SDK for PHP

Last Updated:Mar 11, 2024

A bucket is a container used to store objects in Object Storage Service (OSS). This topic describes how to query information about a bucket.

Usage notes

  • In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS from other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about OSS regions and endpoints, see Regions and endpoints.

  • In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Create an OSSClient instance.

  • To query information about a bucket, you must have the oss:GetBucketInfo permission. For more information, see Attach a custom policy to a RAM user.


The following sample code provides an example on how to query information about a bucket:

if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\Core\OssException;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";
try {
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    $ossClient = new OssClient($config);
    // Query information about the bucket, including the bucket name, region, creation time, storage class, public endpoint, and internal endpoint. 
    $info = $ossClient->getBucketInfo($bucket);    
    printf("bucket name:%s\n", $info->getName());    
    printf("bucket location:%s\n", $info->getLocation());    
    printf("bucket creation time:%s\n", $info->getCreateDate());    
    printf("bucket storage class:%s\n", $info->getStorageClass());   
    printf("bucket extranet endpoint:%s\n", $info->getExtranetEndpoint());    
    printf("bucket intranet endpoint:%s\n", $info->getIntranetEndpoint());
} catch (OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");

print(__FUNCTION__ . ": OK" . "\n");


  • For the complete sample code that is used to query information about a bucket, visit GitHub.

  • For more information about the API operation that you can call to query information about a bucket, see GetBucketInfo.