首页 > 华为云产品及优惠 > 华为云云存储

华为云对象存储OBS设置生命周期规则(Java SDK)_云淘科技

1 月 02, 2024
283 0

功能介绍

OBS支持用户调用设置桶的生命周期配置接口，为指定桶设置生命周期规则，实现定时删除桶中的对象或者定时转换对象的存储类别，从而节省存储费用，更多生命周期相关信息请参见生命周期管理。

对象过期后会被OBS服务端自动删除。
对象转换策略中的时间必须早于对象过期时间；历史版本对象转换策略中的时间也必须早于历史版本对象的过期时间。
桶的多版本状态必须处于Enabled或者Suspended，历史版本对象转换策略和历史版本对象过期时间配置才能生效。

低频访问存储的最低存储时间为30天，归档存储的最低存储时间为90天。若对象经过转换，归档存储时间少于最低存储时间，需要补足剩余天数的存储费用。

开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。

接口约束

单个桶的生命周期规则条数没有限制，但一个桶中所有生命周期规则的XML描述总大小不能超过20KB。
您最多可以在一个并行文件系统下配置20条生命周期管理规则，超过20条将提示不支持。
您必须是桶拥有者或拥有设置桶的生命周期配置的权限，才能设置桶的生命周期配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutLifecycleConfiguration权限，如果使用桶策略则需授予PutLifecycleConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
对象生命周期到期以后，对象将会永久删除，无法恢复。
归档存储不支持多AZ，因此不支持使用生命周期的存储类别转换功能，将多AZ的桶或对象转化为归档存储。

方法定义

obsClient.setBucketLifecycle(final SetBucketLifecycleRequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

deleteRequest

SetBucketLifecycleRequest

必选

参数解释：

设置生命周期请求参数，详见SetBucketLifecycleRequest。
表2 SetBucketLifecycleRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释：

桶名。

约束限制：

桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
桶命名规则如下：

3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
禁止使用IP地址。
禁止以“-”或“.”开头及结尾。
禁止两个“.”相邻（如：“my..bucket”）。
禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。

同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

lifecycleConfig

LifecycleConfiguration

必选

参数解释：

桶生命周期规则列表，详见LifecycleConfiguration。
表3 LifecycleConfiguration

参数名称

参数类型

是否必选

描述

rules

List

可选

参数解释：

桶生命周期规则列表，详见Rule。
表4 Rule

参数名称

参数类型

是否必选

描述

id

String

可选

参数解释：

生命周期规则ID。

取值范围：

长度大于0且不超过255的字符串。

默认取值：

无

prefix

String

必选

参数解释：

对象名前缀，用以标识哪些对象可以匹配到当前这条规则。可为空字符串，代表匹配桶内所有对象。

例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将ExampleObject.jpg指定为前缀，则规则仅应用于该特定对象。如果您将logs/指定为前缀，规则将应用于密钥名称以字符串“logs/”开头的三个对象。如果您指定空的前缀，规则将应用于桶中的所有对象。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

enabled

boolean

必选

参数解释：

标识当前规则是否启用。

取值范围：

true：当前规则启用。

false：当前规则未启用。

默认取值：

无

expiration

Expiration

可选

参数解释：

对象过期时间配置。详见Expiration。

默认取值：

无

noncurrentVersionExpiration

NoncurrentVersionExpiration

可选

参数解释：

历史版本对象过期时间配置，详见NoncurrentVersionExpiration。

约束限制：

仅针对对象的历史版本。
当前桶已启用（或开启后暂停）多版本。

默认取值：

无

transitions

List

可选

参数解释：

对象转换策略列表，用于使用生命周期规则转换对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见Transition。

约束限制：

仅针对对象的最新版本。

默认取值：

无

noncurrentVersionTransitions

List

可选

参数解释：

历史版本对象转换策略列表，用于使用生命周期规则转换历史版本对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见NoncurrentVersionTransition。

约束限制：

仅针对对象的历史版本。
当前桶已启用（或开启后暂停）多版本。

默认取值：

无
表5 Expiration

参数名称

参数类型

是否必选

描述

days

Integer

如果没有设置date则必选

参数解释：

指定生命周期规则在对象最后更新过后多少天生效，即执行过期删除操作。

约束限制：

仅适用于对象的最新版本。

取值范围：

正整数，单位：天。

默认取值：

无

date

Date

如果没有设置days则必选

参数解释：

指定OBS对该日期之前的对象执行生命周期规则，即执行过期删除操作。

默认取值：

无
表6 NoncurrentVersionExpiration

参数名称

参数类型

是否必选

描述

days

Integer

必选

参数解释：

表示对象成为历史版本后第几天时过期。

约束限制：

仅针对历史版本。

取值范围：

正整数，单位：天。

默认取值：

无
表7 Transition

参数名称

参数类型

是否必选

描述

days

Integer

如果没有设置date则必选

参数解释：

表示在对象创建时间后第几天时转换。

约束限制：

仅适用于对象的最新版本。

取值范围：

正整数，单位：天。

默认取值：

无

date

Date

如果没有设置days则必选

参数解释：

表示对象转换的日期。

默认取值：

无

storageClass

StorageClassEnum

必选

参数解释：

对象转换后的存储类别。

约束限制：

对象存储类别转换限制：

仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。
仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动先恢复对象，然后手动转换存储类别。
归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档存储。

取值范围：

生命周期转换的目标存储类别取值范围详见StorageClassEnum。

默认取值：

无
表8 StorageClassEnum

常量名

原始值

说明

STANDARD

STANDARD

标准存储。

WARM

WARM

低频访问存储。

COLD

COLD

归档存储。
表9 NoncurrentVersionTransition

参数名称

参数类型

是否必选

描述

days

Integer

如果没有设置date则必选

参数解释：

表示在对象创建时间后第几天时转换。

约束限制：

仅适用于历史版本。

取值范围：

正整数，单位：天。

默认取值：

无

storageClass

StorageClassEnum

必选

参数解释：

对象转换后的存储类别。

约束限制：

对象存储类别转换限制：

仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。
仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动先恢复对象，然后手动转换存储类别。
归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档存储。

取值范围：

生命周期转换的目标存储类别取值范围详见StorageClassEnum。

默认取值：

无

Transitions、Expiration、NoncurrentVersionTransitions、NoncurrentVersionExpiration、AbortIncompleteMultipartUpload不能全为空。

返回结果说明

表10 返回结果HeaderResponse(SDK公共响应结果)各项属性说明

参数名称

参数类型

描述

statusCode

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。

完整的状态码列表请参见状态码。

默认取值：

无

responseHeaders

Map

参数解释：

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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.LifecycleConfiguration;
import com.obs.services.model.StorageClassEnum;
public class SetBucketLifecycle001 {
    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 {
            // 设置对象转换策略
            LifecycleConfiguration config = new LifecycleConfiguration();
            LifecycleConfiguration.Rule rule = config.new Rule();
            rule.setEnabled(true);
            rule.setId("rule1");
            rule.setPrefix("prefix");
            LifecycleConfiguration.Transition transition = config.new Transition();
            // 指定满足前缀的对象创建30天后转换
            transition.setDays(30);
            // 指定对象转换后的存储类型
            transition.setObjectStorageClass(StorageClassEnum.WARM);
            // 直接指定满足前缀的对象转换日期
            // transition.setDate(new SimpleDateFormat("yyyy-MM-dd").parse("2018-10-31"));
            rule.getTransitions().add(transition);
            LifecycleConfiguration.NoncurrentVersionTransition noncurrentVersionTransition =
                    config.new NoncurrentVersionTransition();
            // 指定满足前缀的对象成为历史版本30天后转换
            noncurrentVersionTransition.setDays(30);
            // 指定历史版本对象转换后的存储类型
            noncurrentVersionTransition.setObjectStorageClass(StorageClassEnum.COLD);
            rule.getNoncurrentVersionTransitions().add(noncurrentVersionTransition);
            // 设置碎片过期时间
            LifecycleConfiguration.AbortIncompleteMultipartUpload abortIncompleteMultipartUpload = config.new AbortIncompleteMultipartUpload();
            abortIncompleteMultipartUpload.setDaysAfterInitiation(7);
            rule.setAbortIncompleteMultipartUpload(abortIncompleteMultipartUpload);
            config.addRule(rule);
            obsClient.setBucketLifecycle("examplebucket", config);
            System.out.println("setBucketLifecycle successfully");
        } catch (ObsException e) {
            System.out.println("setBucketLifecycle 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("setBucketLifecycle failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

代码示例：设置对象过期时间

以下代码展示了如何设置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
53
54
55
56
57
58
59
60
61
62
63
 
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.LifecycleConfiguration;
public class SetBucketLifecycle002 {
    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 {
            // 设置对象过期时间
            LifecycleConfiguration config = new LifecycleConfiguration();
            LifecycleConfiguration.Rule rule = config.new Rule();
            rule.setEnabled(true);
            rule.setId("rule1");
            rule.setPrefix("prefix");
            LifecycleConfiguration.Expiration expiration = config.new Expiration();
            // 指定满足前缀的对象创建60天后过期
            expiration.setDays(60);
            // 直接指定满足前缀的对象过期时间
            // expiration.setDate(new SimpleDateFormat("yyyy-MM-dd").parse("2018-12-31"));
            rule.setExpiration(expiration);
            LifecycleConfiguration.NoncurrentVersionExpiration noncurrentVersionExpiration =
                    config.new NoncurrentVersionExpiration();
            // 指定满足前缀的对象成为历史版本60天后过期
            noncurrentVersionExpiration.setDays(60);
            rule.setNoncurrentVersionExpiration(noncurrentVersionExpiration);
            config.addRule(rule);
            obsClient.setBucketLifecycle("examplebucket", config);
            System.out.println("setBucketLifecycle successfully");
        } catch (ObsException e) {
            System.out.println("setBucketLifecycle 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("setBucketLifecycle failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

相关链接

关于设置桶的生命周期配置的API说明，请参见设置桶的生命周期配置。
更多关于设置桶的生命周期配置的示例代码，请参见Github示例。
设置桶的生命周期配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
生命周期管理相关问题请参见生命周期管理相关问题。

父主题： 生命周期管理(Java SDK)

同意关联代理商云淘科技，购买华为云产品更优惠（QQ 78315851）

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家

相关文章

分类

近期文章

近期评论

您尚未收到任何评论。

友情链接

同尘科技 同尘云 云淘科技 数据百度 西数云 站长论坛 阿里云代理 阿里云代理商 阿里云优惠 腾讯云代理 腾讯云优惠 云小二

分类目录