文档

Java获取存储空间的信息

更新时间:

存储空间(Bucket)是存储对象(Object)的容器。本文介绍如何获取存储空间的信息。

注意事项

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

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

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

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

示例代码

以下代码用于获取存储空间的信息(Info),包括存储空间所在地域、创建日期等。

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 {
        // 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";
        
        // 创建OSSClient实例。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            // 存储空间的信息包括地域(Region或Location)、创建日期(CreationDate)、拥有者(Owner)等。
            // 填写Bucket名称,例如examplebucket。
            BucketInfo info = ossClient.getBucketInfo(bucketName);
            // 获取地域。
            System.out.println(info.getBucket().getLocation());
            // 获取创建日期。
            System.out.println(info.getBucket().getCreationDate());
            // 获取拥有者信息。
            System.out.println(info.getBucket().getOwner());           
            // 获取容灾类型。
            System.out.println(info.getDataRedundancyType());
            // 获取访问跟踪状态。仅Java SDK 3.16.0及以上版本支持获取访问跟踪状态。
            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();
            }
        }
    }
}

相关文档

关于获取存储空间信息的API接口说明,请参见GetBucketInfo