华为云对象存储OBS获取桶配额(Java SDK)_云淘科技
功能说明
桶配额是桶容量的上限值。调用获取桶配额接口,可获取指定桶的配额值。桶配额为0代表桶容量没有上限。
接口约束
桶配额值必须为非负整数,单位为字节。
桶的拥有者的状态是欠费冻结状态时不可以查询桶配额信息。
您必须是桶拥有者或拥有获取桶配额的权限,才能获取桶配额。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketQuota权限,如果使用桶策略则需授予GetBucketQuota权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
方法定义
obsClient.getBucketQuota(String bucketName)
获取桶配额请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketName |
String |
必选 |
参数解释: 桶名。 约束限制: 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。 默认取值: 无 |
返回结果说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketQuota |
long |
必选 |
参数解释: 桶的配额值。 取值范围: 非负整数,单位:字节。 默认取值: 0,表示没有限制桶配额。 |
代码示例
本示例用于获取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 |
import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.BucketQuota; public class GetBucketQuota001 { 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.cn-north-4.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"; //获取桶配额 BucketQuota quota = obsClient.getBucketQuota(exampleBucket); System.out.println("GetBucketQuota successfully"); System.out.println("GetBucketQuota:" + quota.getBucketQuota() + " bytes"); } catch (ObsException e) { System.out.println("GetBucketQuota 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("GetBucketQuota failed"); // 其他异常信息打印 e.printStackTrace(); } } } |
相关链接
关于获取桶配额的API说明,请参见获取桶配额。
更多关于桶配额的示例代码,请参见Github示例。
设置桶配额过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
桶和对象相关常见问题请参见桶和对象相关常见问题。
父主题: 管理桶(Java SDK)
同意关联代理商云淘科技,购买华为云产品更优惠(QQ 78315851)
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家