更新时间:2024-06-18 GMT+08:00
获取桶存量信息(Java SDK)
功能说明
桶存量信息包括桶已使用的空间大小以及桶包含的对象个数。您可以通过ObsClient.getBucketStorageInfo获取桶的存量信息。
由于OBS桶存量是后台统计,因此存量会有一定的时延,不能实时更新,因此不建议对存量做实时校验。
开发过程中,您有任何问题可以在github上提交issue。
接口约束
- 您必须是桶拥有者或拥有获取桶存量信息的权限,才能获取桶存量信息。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketStorageInfo权限,如果使用桶策略则需授予GetBucketStorage权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
方法定义
obsClient.getBucketStorageInfo(String bucketName)
请求参数说明
返回结果说明
参数名称 |
参数类型 |
描述 |
---|---|---|
statusCode |
int |
参数解释: HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值: 无 |
responseHeaders |
Map<String, Object> |
参数解释: 响应消息头列表,由多个元组构成。元组中String代表响应消息头的名称,Object代表响应消息头的值。 默认取值: 无 |
size |
long |
参数解释: 桶中对象占用的空间大小。 取值范围: 值为非负整数,单位为Byte(字节)。 默认取值: 无 |
objectNum |
long |
参数解释: 桶内对象个数。 默认取值: 无 |
代码示例
本示例用于获取exampleBucket桶的桶存量信息。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.BucketStorageInfo; public class GetBucketStorageInfo001 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken,也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以中国-香港为例,其他地区请按实际情况填写。 String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { //示例桶名 String exampleBucket = "examplebucket"; //获取桶存量信息 BucketStorageInfo storageInfo = obsClient.getBucketStorageInfo(exampleBucket); System.out.println("GetBucketStorageInfo successfully"); System.out.println("GetObjectNumber:" + storageInfo.getObjectNumber()); System.out.println("GetStorageSize:" + storageInfo.getSize() + " bytes"); } catch (ObsException e) { System.out.println("GetBucketStorageInfo failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("GetBucketStorageInfo failed"); // 其他异常信息打印 e.printStackTrace(); } } } |
相关链接
- 关于获取桶存量信息的API说明,请参见获取桶存量信息。
- 更多关于获取桶存量信息的示例代码,请参见Github示例。
- 获取桶存量信息过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
- 桶和对象相关常见问题请参见桶和对象相关常见问题。
父主题: 管理桶(Java SDK)