Object Storage Service:Get bucket information (PHP SDK V1)

Notes

• In this topic, the public endpoint of the China (Hangzhou) region is used. To access OSS from other Alibaba Cloud services in the same region, use an internal endpoint. For details about supported 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 retrieve information about a bucket, you must have the oss:GetBucketInfo permission. For more information, see Grant custom permissions to a RAM user.

Example code

The following code shows how to retrieve information about a bucket:

<?php
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 set.
$provider = new EnvironmentVariableCredentialsProvider();
// The endpoint of the China (Hangzhou) region is used as an example. Replace it with the actual endpoint.
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the bucket name. Example: examplebucket.
$bucket= "examplebucket";
try {
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
    // Get bucket information, including the bucket name (Name), region (Location), creation date (CreateDate), storage class (StorageClass), public endpoint (ExtranetEndpoint), and internal endpoint (IntranetEndpoint).
    $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");
    return;
}  

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

References

• For the complete sample code that shows how to retrieve bucket information, see the GitHub example.

• For more information about the API operation that is used to retrieve bucket information, see GetBucketInfo.