全部產品
Search
文件中心

Object Storage Service:Java擷取儲存空間的資訊

更新時間:Oct 19, 2024

儲存空間(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";
        // 填寫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 {
            // 儲存空間的資訊包括地區(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