All Products
Search
Document Center

Object Storage Service:Query bucket information

Last Updated:Sep 11, 2023

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 by using other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about the regions and endpoints supported by OSS, see Regions and endpoints.

  • In this topic, access credentials are obtained from environment variables. For more information about how to configure access credentials, see Configure access credentials.

  • 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 Common examples of RAM policies.

Examples

The following code provides an example on how to query information about a bucket, including the region and creation date of the bucket:

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.BucketInfo;

public class Demo {
    public static void main(String[] args) throws Exception {
        // In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 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. 
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the name of the bucket. Example: examplebucket. 
        String bucketName = "examplebucket";
        
        // Create an OSSClient instance. 
        OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

        try {
            // Information about a bucket includes the region (Region or Location), creation date (CreationDate), and owner (Owner) of the bucket. 
            // Specify the name of the bucket. Example: examplebucket. 
            BucketInfo info = ossClient.getBucketInfo(bucketName);
            // Query the region in which the bucket is located. 
            System.out.println(info.getBucket().getLocation());
            // Query the creation date of the bucket. 
            System.out.println(info.getBucket().getCreationDate());
            // Query the owner of the bucket. 
            System.out.println(info.getBucket().getOwner());           
            // Query the redundancy type of the bucket. 
            System.out.println(info.getDataRedundancyType());
            // Query the access tracking status of the bucket. Only OSS SDK for Java 3.16.0 or later allows you to query the access tracking status of a bucket. 
            System.out.println(info.getBucket().getAccessMonitor());
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

References

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