设置桶存储类别(Java SDK)
功能介绍
OBS提供了这些存储类别:标准存储、低频访问存储、归档存储、深度归档存储,从而满足客户业务对存储性能、成本的不同诉求。
调用设置桶存储类别接口,可设置指定桶的存储类别。设置了桶的默认存储类别之后,如果上传对象、复制对象和初始化多段上传任务时未指定对象的存储类别,则该对象的存储类别默认与桶的存储类别保持一致。
开发过程中,您有任何问题可以在Github上提交issue,或者在华为云对象存储服务论坛中发帖求助。
桶的存储类别见下表:
| 类型 | 说明 | OBS Java SDK对应值 |
|---|---|---|
| 标准存储 | 标准存储拥有低访问时延和较高的吞吐量,适用于有大量热点对象(平均一个月多次)或小对象(<1MB),且需要频繁访问数据的业务场景。 | StorageClassEnum.STANDARD |
| 低频访问存储 | 低频访问存储适用于不频繁访问(平均一年少于12次)但在需要时也要求能够快速访问数据的业务场景。 | StorageClassEnum.WARM |
| 归档存储 | 归档存储适用于很少访问(平均一年访问一次)数据的业务场景。 | StorageClassEnum.COLD |
| 深度归档存储 | 适用于长期不访问(平均几年访问一次)数据的业务场景。 | StorageClassEnum.DEEP_ARCHIVE |
更多关于桶存储类别的内容请参考桶的存储类别。
接口约束
- 您必须是桶拥有者或拥有设置桶存储类别的权限,才能设置桶存储类别。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:PutBucketStoragePolicy权限,如果使用桶策略则需授予PutBucketStoragePolicy权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
- 桶的存储类别与桶中对象的存储类别是相互独立的。如果上传对象时,未设置对象的存储类别,该对象默认与桶的存储类别一致,但后续如果修改桶的存储类别,已上传的桶中对象的存储类别不会随之改变;如果后续修改桶中对象的存储类别时,该桶的存储类别也不会随之改变。
方法定义
obsClient.setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| bucketName | String | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| bucketStorage | BucketStoragePolicyConfiguration (继承HeaderResponse) | 必选 | 参数解释: 桶的存储类别。 取值范围: 存储类别取值详见BucketStoragePolicyConfiguration。 默认取值: 无 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| storageClass | 参数解释: 桶的存储类别。 取值范围: 存储类别取值详见桶的StorageClassEnum。 默认取值: 无 |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| statusCode | int | 参数解释: HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。 完整的状态码列表请参见状态码。 默认取值: 无 |
| responseHeaders | Map<String, Object> | 参数解释: HTTP响应消息头列表,由多个元组构成。元组中String代表响应消息头的名称,Object代表响应消息头的值。 默认取值: 无 |
代码示例
本示例用于设置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 51 52 | import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.BucketStoragePolicyConfiguration; import com.obs.services.model.StorageClassEnum; public class SetBucketStoragePolicy001 { 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"; // 设置桶的存储类别为低频访问存储. BucketStoragePolicyConfiguration storgePolicy = new BucketStoragePolicyConfiguration(); storgePolicy.setBucketStorageClass(StorageClassEnum.WARM); obsClient.setBucketStoragePolicy(exampleBucket, storgePolicy); System.out.println("SetBucketStoragePolicy successfully"); } catch (ObsException e) { System.out.println("SetBucketStoragePolicy 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("SetBucketStoragePolicy failed"); // 其他异常信息打印 e.printStackTrace(); } } } |
相关链接
- 关于设置桶存储类别的API说明,请参见设置桶存储类别。
- 更多关于桶存储类别的示例代码,请参见Github示例。
- 设置桶存储类别过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
- 桶和对象相关常见问题请参见桶和对象相关常见问题。