# 设置桶级默认WORM策略(Java SDK) #### 功能介绍 本接口用于为指定桶配置默认保护策略和保护期限。 当您在桶内配置了桶级默认WORM策略以后，如果您在上传对象时没有指定保护策略和保护期限，则新上传的对象会自动应用桶级默认WORM策略。和配置对象级WORM保护策略不同的地方在于，对象级WORM保护策略需要您提供一个明确的时间，在这个时间之前对象都会受到保护，桶级默认WORM策略则要求您提供一个保护期限，实际上对象受到保护的时间点为其上传时间+您指定的保护期限。 ![](https://support.huaweicloud.com/sdk-java-devg-obs/public_sys-resources/note_3.0-zh-cn.png) - 您可以修改甚至清空桶级默认WORM策略，但这仅对修改后上传的对象生效，修改前上传的对象的保护状态不受影响。 - 多段上传的对象在合并前不受保护，合并后受桶级默认对象策略保护，您可以在其合并后单独为其配置对象级WORM保护策略。 #### 接口约束 - 您必须是桶拥有者或者拥有配置桶级默认WORM策略权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketObjectLockConfiguration权限，如果使用桶策略则需授予PutBucketObjectLockConfiguration权限。相关授权方式介绍可参见[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_0123.html)。 - 策略目前仅支持设置为合规模式"COMPLIANCE" - 支持设置的保留期限为1天-100\*365天或1年\~100年。 - OBS支持的region以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 obsClient.setObjectLockConfiguration(SetObjectLockConfigurationRequest request) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | request | [表2 SetObjectLockConfigurationRequest] | 必选 | **参数解释** **：** 设置桶级默认WORM策略请求参数，详见[表2 SetObjectLockConfigurationRequest]。 | 表2SetObjectLockConfigurationRequest | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | String | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | objectLockConfiguration | [表3 ObjectLockConfiguration] | 必选 | **参数解释：** WORM策略配置，详见[表3 ObjectLockConfiguration]。 | 表3ObjectLockConfiguration | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | objectLockEnabled | String | 必选 | **参数解释：** 桶级WORM开关状态。 **约束限制：** 不涉及 **取值范围：** Enabled：启用桶级WORM功能。 **默认取值：** 不涉及 | | rule | [表4 ObjectLockRule] | objectLockEnabled为Enabled时必选，不携带则会清空当前配置的桶级默认WORM策略 | **参数解释：** 桶级WORM策略的规则。 **约束限制：** 不携带则会清空当前配置的桶级默认WORM策略 **取值范围：** 详见[表4 ObjectLockRule]。 **默认取值：** 不涉及 | 表4ObjectLockRule | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | defaultRetention | [表5 DefaultRetention] | 可选 | **参数解释：** 桶级默认WORM策略。 **约束限制：** 无 **取值范围：** 详见[表5 DefaultRetention] **默认取值：** 无 | 表5DefaultRetention | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | mode | String | 必选 | **参数解释：** 桶的WORM保护策略。 **约束限制：** 不涉及 **取值范围：** COMPLIANCE：合规模式。 **默认取值：** COMPLIANCE | | days | int | 和years二选一，必须选择其中一个且不能同时指定 | **参数解释：** 保护天数。单位：天。 **约束限制：** days和years只能有一个不为0，并且在规定取值范围内。 **取值范围：** 1\~36500 **默认取值：** 不涉及 | | years | int | 和days二选一，必须选择其中一个且不能同时指定 | **参数解释：** 默认的保护年数，单位：年。 **约束限制：** - 一年实际上视为保护365天，不考虑闰年。 - days和years只能有一个不为0，并且在规定取值范围内。 **取值范围：** 1\~100 **默认取值：** 不涉及 | #### 返回结果说明 表6返回结果HeaderResponse(SDK公共响应结果)各项属性说明 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | statusCode | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | responseHeaders | Map\ | **参数解释：** HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无 | #### 代码示例 本示例用于设置examplebucket桶的默认WORM策略。 ``` import com.obs.services.ObsClient; import com.obs.services.ObsConfiguration; import com.obs.services.exception.ObsException; import com.obs.services.model.objectlock.DefaultRetention; import com.obs.services.model.objectlock.ObjectLockConfiguration; import com.obs.services.model.objectlock.ObjectLockRule; import com.obs.services.model.objectlock.SetObjectLockConfigurationRequest; public class SetObjectLockConfiguration { 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"; DefaultRetention retention = new DefaultRetention("COMPLIANCE", 30, null); ObjectLockRule rule = new ObjectLockRule(retention); ObjectLockConfiguration config = new ObjectLockConfiguration("Enabled", rule); SetObjectLockConfigurationRequest request = new SetObjectLockConfigurationRequest(exampleBucket, config); obsClient.setObjectLockConfiguration(request); System.out.println("SetObjectLockConfiguration successfully"); } catch (ObsException e) { System.out.println("SetObjectLockConfiguration 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("SetObjectLockConfiguration failed"); // 其他异常信息打印 e.printStackTrace(); } } } ``` #### 相关链接 - 更多示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-java-obs/blob/master/app/src/test/java/samples_java/PFSBucketAndObjectOperationSample.java)。 - 设置桶级默认WORM策略过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。