Object Storage Service:Query the storage capacity of 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 the storage capacity of a bucket, you must have the oss:GetBucketStat permission. For more information, see Common examples of RAM policies.

Examples

The following sample code provides an example on how to query the storage capacity of a bucket named examplebucket, the number of objects of different storage classes in the bucket, and the storage usage of the objects:

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.model.BucketStat;

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 {
            BucketStat stat = ossClient.getBucketStat(bucketName);
            // Query the total storage capacity of the bucket. Unit: bytes. 
            System.out.println(stat.getStorageSize());
            // Query the total number of objects that are stored in the bucket. 
            System.out.println(stat.getObjectCount());
            // Query the number of multipart upload tasks that have been initiated but are not completed or canceled. 
            System.out.println(stat.getMultipartUploadCount());
            // Query the storage usage of Standard objects in the bucket. Unit: bytes. 
            System.out.println(stat.getStandardStorage());
            // Query the number of Standard objects in the bucket. 
            System.out.println(stat.getStandardObjectCount());
            // Query the number of LiveChannels in the bucket. 
            System.out.println(stat.getLiveChannelCount());
            // Query the time when the obtained information was last modified. The value is a UNIX timestamp. Unit: seconds. 
            System.out.println(stat.getLastModifiedTime());
            // Query the billed storage usage of Infrequent Access (IA) objects in the bucket. Unit: bytes. 
            System.out.println(stat.getInfrequentAccessStorage());
            // Query the actual storage usage of IA objects in the bucket. Unit: bytes. 
            System.out.println(stat.getInfrequentAccessRealStorage());
            // Query the number of IA objects in the bucket. 
            System.out.println(stat.getInfrequentAccessObjectCount());
            // Query the billed storage usage of Archive objects in the bucket. Unit: bytes. 
            System.out.println(stat.getArchiveStorage());
            // Query the actual storage usage of Archive objects in the bucket. Unit: bytes. 
            System.out.println(stat.getArchiveRealStorage());
            // Query the number of Archive objects in the bucket. 
            System.out.println(stat.getArchiveObjectCount());
            // Query the billed storage usage of Cold Archive objects in the bucket. Unit: bytes. 
            System.out.println(stat.getColdArchiveStorage());
            // Query the actual storage usage of Cold Archive objects in the bucket. Unit: bytes. 
            System.out.println(stat.getColdArchiveRealStorage());
            // Query the number of Cold Archive objects in the bucket. 
            System.out.println(stat.getColdArchiveObjectCount());
        } 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 the storage capacity of a specified bucket, the number of objects of different storage classes in the bucket, and the storage usage of the objects, see GetBucketStat.