Java获取存储空间的存储容量

注意事项

• 本文以华东1（杭州）外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS访问域名、数据中心、开放端口。

• 本文以从环境变量读取访问凭证为例。如何配置访问凭证，请参见Java配置访问凭证。

• 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient，请参见新建OSSClient。

• 要获取存储空间的存储容量，您必须有oss:GetBucketStat权限。具体操作，请参见为RAM用户授权自定义的权限策略。

示例代码

以下代码用于获取examplebucket的存储容量以及该Bucket内不同存储类型Object的数量及其存储容量。

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 {
        // Endpoint以华东1（杭州）为例，其它Region请按实际情况填写。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // 填写Bucket名称，例如examplebucket。
        String bucketName = "examplebucket";
        // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为cn-hangzhou。
        String region = "cn-hangzhou";
        
        // 创建OSSClient实例。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            BucketStat stat = ossClient.getBucketStat(bucketName);
            // 获取Bucket的总存储量，单位为字节。
            System.out.println("StorageSize:"+stat.getStorageSize());
            // 获取Bucket中总的Object数量。
            System.out.println("ObjectCount:"+stat.getObjectCount());
            // 获取Bucket中已经初始化但还未完成（Complete）或者还未中止（Abort）的Multipart Upload数量。
            System.out.println("MultipartUploadCount:"+stat.getMultipartUploadCount());
            // 获取标准存储类型Object的存储量，单位为字节。
            System.out.println("StandardStorage:"+stat.getStandardStorage());
            // 获取标准存储类型的Object的数量。
            System.out.println("StandardObjectCount:"+stat.getStandardObjectCount());
            // 获取Bucket中Live Channel的数量。
            System.out.println("LiveChannelCount:"+stat.getLiveChannelCount());
            // 此次调用获取到的存储信息的时间点，格式为时间戳，单位为秒。
            System.out.println("LastModifiedTime:"+stat.getLastModifiedTime());
            // 获取低频存储类型Object的计费存储量，单位为字节。
            System.out.println("InfrequentAccessStorage:"+stat.getInfrequentAccessStorage());
            // 获取低频存储类型Object的实际存储量，单位为字节。
            System.out.println("InfrequentAccessRealStorage:"+stat.getInfrequentAccessRealStorage());
            // 获取低频存储类型的Object数量。
            System.out.println("InfrequentAccessObjectCount:"+stat.getInfrequentAccessObjectCount());
            // 获取归档存储类型Object的计费存储量，单位为字节。
            System.out.println("ArchiveStorage:"+stat.getArchiveStorage());
            // 获取归档存储类型Object的实际存储量，单位为字节。
            System.out.println("ArchiveRealStorage:"+stat.getArchiveRealStorage());
            // 获取归档存储类型的Object数量。
            System.out.println("ArchiveObjectCount:"+stat.getArchiveObjectCount());
            // 获取冷归档存储类型Object的计费存储量，单位为字节。
            System.out.println("ColdArchiveStorage:"+stat.getColdArchiveStorage());
            // 获取冷归档存储类型Object的实际存储量，单位为字节。
            System.out.println("ColdArchiveRealStorage:"+stat.getColdArchiveRealStorage());
            // 获取冷归档存储类型的Object数量。
            System.out.println("ColdArchiveObjectCount:"+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();
            }
        }
    }
}

相关文档

关于获取指定Bucket的存储容量以及该Bucket内不同存储类型Object的数量及其存储容量的API接口说明，请参见GetBucketStat。