This topic describes how to use Object Storage Service (OSS) SDK for PHP to query information about a bucket, such as the access tracking state, region, creation date, access control list (ACL), name and ID of the owner, storage class, redundancy type, public endpoint, internal endpoint, cross-region replication (CRR) state, versioning state, and encryption method. This helps you perform subsequent operations.
Usage notes
-
The sample code in this topic uses the region ID
cn-hangzhouof the China (Hangzhou) region. By default, a public endpoint is used to access resources in a bucket. If you want to access resources in the bucket by using other Alibaba Cloud services in the same region in which the bucket is located, use an internal endpoint. For more information about OSS regions and endpoints, see Regions and endpoints. -
To query information about a bucket, you must have the
oss:GetBucketInfopermission. For more information, see Grant a custom policy.
Examples
The following sample code provides an example on how to query information about a bucket:
<?php
require_once __DIR__ . '/../vendor/autoload.php'; // Automatically load objects and dependency libraries.
use AlibabaCloud\Oss\V2 as Oss;
// Specify command line parameters.
$optsdesc = [
"region" => ['help' => The region in which the bucket is located.', 'required' => True], // (Required) Specify the region in which the bucket is located. Example: oss-cn-hangzhou.
"endpoint" => ['help' => The domain names that other services can use to access OSS.', 'required' => False], // (Optional) Specify the endpoint that can be used by other services to access OSS.
"bucket" => ['help' => The name of the bucket, 'required' => True], // (Required) Specify the name of the bucket.
];
$longopts = \array_map(function ($key) {
return "$key:"; // Add a colon (:) to the end of each parameter to indicate that a value is required.
}, array_keys($optsdesc));
// Parse the command line parameters.
$options = getopt("", $longopts);
// Check whether the required parameters are configured.
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // Specifies that the required parameters are not configured.
exit(1);
}
}
// Obtain the values of the command line parameters.
$region = $options["region"]; // The region in which the bucket is located.
$bucket = $options["bucket"]; // The name of the bucket.
// Use environment variables to load the credential information (AccessKey ID and AccessKey secret).
$credentialsProvider=new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // Obtain the credential information from the environment variables.
// Use the default configurations of the SDK.
$cfg=Oss\Config::loadDefault(); // Load the default configurations of the SDK.
$cfg->setCredentialsProvider($credentialsProvider); // Specify the credential provider.
$cfg->setRegion($region); // Specify the region.
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // Specify the endpoint if an endpoint is provided.
}
// Create an OSSClient instance.
$client = new Oss\Client($cfg); // Create an OSSClient instance.
// Create a request to query information about the bucket.
$request = new Oss\Models\GetBucketInfoRequest($bucket); // Create a request to query information about the bucket.
// Use the getBucketInfo method to query information about the bucket.
$result = $client->getBucketInfo($request); // Use the getBucketInfo method to query information about the bucket.
// Display the returned result.
printf(
'status code:' . $result-> statusCode. PHP_EOL . // The HTTP response status code.
'request id:' . $result-> requestId. PHP_EOL . // The unique identifier of the request.
'bucket info:' . var_export($result->bucketInfo, true) // The detailed information about the bucket.
);
References
-
For more information about buckets, see Bucket overview.
-
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.