# 配置对象级WORM保护策略(Java SDK) #### 功能介绍 开启了WORM开关的桶，上传的对象支持配置或修改对象保护期限。 - 如果上传对象时没有配置保护期限或自动应用桶级默认保护策略，您可以通过该操作配置对象保护期限。 - 如果上传对象时配置了保护期限或自动应用了默认保护期限，允许用户通过该操作延长保护期限。 - 对象保护期限仅允许修改，不允许删除。 #### 接口约束 - 您必须是桶拥有者或拥有配置对象级WORM保护策略的权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObjectRetention权限，如果使用桶策略则需授予PutObjectRetention权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[配置对象策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0075.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 obsClient.setObjectRetention(SetObjectRetentionRequest request) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | request | [表2] | 必选 | **参数解释** **：** 配置对象级WORM保护策略请求参数，详见[表2]。 | 表2SetObjectRetentionRequest | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | String | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | objectKey | String | 必选 | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt中，对象名为folder/test.txt。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | retention | [表3] | 必选 | **参数解释：** 对象级WORM保护策略，详见[表3] | | versionId | String | 可选 | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9。 **取值范围：** 长度为32的字符串。 **默认取值：** 无，如果不设置则默认指定最新版本的对象。 | 表3ObjectRetention | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | mode | String | 必选 | **参数解释：** 对象的WORM保护策略。 **约束限制：** 不涉及 **取值范围：** COMPLIANCE：合规模式。 **默认取值：** 无 | | retainUntilDate | String | 必选 | **参数解释：** 对象的保护期限。示例：1435728035000。 **约束限制：** - 时间戳格式，精确到毫秒级，如2015年7月1日13点20分35秒对应的值为1435728035000。 - 仅可延长不能缩短。 **取值范围：** 必须晚于当前时间。 **默认取值：** 无 | #### 返回结果说明 表4HeaderResponse | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | statusCode | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | responseHeaders | Map\ | **参数解释：** 响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无 | #### 代码示例 本示例用于设置examplebucket桶的exampleObject对象的WORM保护策略。 ``` import com.obs.services.ObsClient; import com.obs.services.ObsConfiguration; import com.obs.services.exception.ObsException; import com.obs.services.model.objectlock.ObjectRetention; import com.obs.services.model.objectlock.SetObjectRetentionRequest; public class SetObjectRetention { 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, 此处以华北-北京四为例，其他地区请按实际情况填写。 // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 String endPoint = System.getenv("ENDPOINT"); ObsConfiguration obsConfiguration = new ObsConfiguration(); obsConfiguration.setEndPoint(endPoint); ObsClient obsClient = new ObsClient(ak, sk, securityToken, obsConfiguration); try { String exampleBucket = "examplebucket"; String exampleObject = "exampleObject"; long retainUntilDate = System.currentTimeMillis() + 30L * 24 * 60 * 60 * 1000; ObjectRetention retention = new ObjectRetention("COMPLIANCE", retainUntilDate); SetObjectRetentionRequest request = new SetObjectRetentionRequest(exampleBucket, exampleObject, retention); obsClient.setObjectRetention(request); System.out.println("SetObjectRetention successfully"); } catch (ObsException e) { System.out.println("SetObjectRetention 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("SetObjectRetention failed"); // 其他异常信息打印 e.printStackTrace(); } } } ``` #### 相关链接 - 关于配置对象级WORM保护策略的API说明，请参见[配置对象级WORM保护策略](https://support.huaweicloud.com/api-obs/obs_04_0166.html)。 - 配置对象级WORM保护策略过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。