本文介紹如何擷取指定儲存空間(Bucket)的儲存容量以及Bucket內不同儲存類型檔案(Object)的數量及其儲存容量。
注意事項
本文以華東1(杭州)外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS訪問網域名稱、資料中心、開放連接埠。
本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見Java配置訪問憑證。
本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient,請參見建立OSSClient。
要擷取儲存空間的儲存容量,您必須有
oss:GetBucketStat
許可權。具體操作,請參見為RAM使用者授權自訂的權限原則。
範例程式碼
以下代碼用於擷取examplebucket的儲存容量以及該Bucket內不同儲存類型Object的數量及其儲存容量。
重要
僅Java SDK 3.14.1及以上版本支援返回以下範例程式碼中包含的所有屬性。
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());
// 擷取Archive Storage類型Object的計費儲存量,單位為位元組。
System.out.println("ArchiveStorage:"+stat.getArchiveStorage());
// 擷取Archive Storage類型Object的實際儲存量,單位為位元組。
System.out.println("ArchiveRealStorage:"+stat.getArchiveRealStorage());
// 擷取Archive Storage類型的Object數量。
System.out.println("ArchiveObjectCount:"+stat.getArchiveObjectCount());
// 擷取冷Archive Storage類型Object的計費儲存量,單位為位元組。
System.out.println("ColdArchiveStorage:"+stat.getColdArchiveStorage());
// 擷取冷Archive Storage類型Object的實際儲存量,單位為位元組。
System.out.println("ColdArchiveRealStorage:"+stat.getColdArchiveRealStorage());
// 擷取冷Archive Storage類型的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。