Object Storage Service:バケットのストレージ容量のクエリ (Java SDK V1)

注意事項

• このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスするには、内部エンドポイントを使用します。サポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

• このトピックでは、アクセス認証情報は環境変数から取得されます。アクセス認証情報の設定方法の詳細については、「アクセス認証情報の設定」をご参照ください。

• このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。カスタムドメイン名または Security Token Service (STS) を使用して OSSClient インスタンスを作成する場合は、「一般的なシナリオの設定例」をご参照ください。

• バケットのストレージ容量をクエリするには、oss:GetBucketStat 権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーのアタッチ」をご参照ください。

サンプルコード

次のコードは、examplebucket という名前のバケットのストレージ容量、およびバケット内の各ストレージクラスのオブジェクト数とストレージ容量を取得します。

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

public class Demo {
    public static void main(String[] args) throws Exception {
        // この例では、中国 (杭州) リージョンのエンドポイントを使用します。実際のエンドポイントを指定してください。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 環境変数からアクセス認証情報を取得します。このコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // バケット名を指定します。例：examplebucket。
        String bucketName = "examplebucket";
        // バケットが配置されているリージョンを指定します。たとえば、バケットが中国 (杭州) リージョンにある場合は、リージョンを cn-hangzhou に設定します。
        String region = "cn-hangzhou";

        // OSSClient インスタンスを作成します。
        // OSSClient インスタンスが不要になったら、shutdown メソッドを呼び出してリソースを解放します。
        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);
            // バケットの合計ストレージ容量をバイト単位で取得します。
            System.out.println("StorageSize:"+stat.getStorageSize());
            // バケット内のオブジェクトの総数を取得します。
            System.out.println("ObjectCount:"+stat.getObjectCount());
            // 開始されたが完了または中止されていないマルチパートアップロードタスクの数を取得します。
            System.out.println("MultipartUploadCount:"+stat.getMultipartUploadCount());
            // 標準ストレージオブジェクトのストレージ容量をバイト単位で取得します。
            System.out.println("StandardStorage:"+stat.getStandardStorage());
            // 標準ストレージオブジェクトの数を取得します。
            System.out.println("StandardObjectCount:"+stat.getStandardObjectCount());
            // バケット内の LiveChannel の数を取得します。
            System.out.println("LiveChannelCount:"+stat.getLiveChannelCount());
            // ストレージ情報が取得された時刻。値は秒単位の UNIX タイムスタンプです。
            System.out.println("LastModifiedTime:"+stat.getLastModifiedTime());
            // 低頻度アクセス (IA) オブジェクトの課金対象ストレージ容量をバイト単位で取得します。
            System.out.println("InfrequentAccessStorage:"+stat.getInfrequentAccessStorage());
            // IA オブジェクトの実際のストレージ容量をバイト単位で取得します。
            System.out.println("InfrequentAccessRealStorage:"+stat.getInfrequentAccessRealStorage());
            // IA オブジェクトの数を取得します。
            System.out.println("InfrequentAccessObjectCount:"+stat.getInfrequentAccessObjectCount());
            // アーカイブストレージオブジェクトの課金対象ストレージ容量をバイト単位で取得します。
            System.out.println("ArchiveStorage:"+stat.getArchiveStorage());
            // アーカイブストレージオブジェクトの実際のストレージ容量をバイト単位で取得します。
            System.out.println("ArchiveRealStorage:"+stat.getArchiveRealStorage());
            // アーカイブストレージオブジェクトの数を取得します。
            System.out.println("ArchiveObjectCount:"+stat.getArchiveObjectCount());
            // コールドアーカイブオブジェクトの課金対象ストレージ容量をバイト単位で取得します。
            System.out.println("ColdArchiveStorage:"+stat.getColdArchiveStorage());
            // コールドアーカイブオブジェクトの実際のストレージ容量をバイト単位で取得します。
            System.out.println("ColdArchiveRealStorage:"+stat.getColdArchiveRealStorage());
            // コールドアーカイブオブジェクトの数を取得します。
            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();
            }
        }
    }
}

関連ドキュメント

バケットのストレージ容量、およびバケット内の各ストレージクラスのオブジェクト数とストレージ容量を取得するために呼び出すことができる API 操作の詳細については、「GetBucketStat」をご参照ください。