## **功能描述** 此接口用于设置桶的保留策略。配置桶的保留策略后，上传对象时如果没有指定对象保留时间，则新上传的对象会默认继承桶的保留时间。 ## 注意事项 * 为对象设置保留时间后，该时间不支持取消，仅可在保留时间到期后自动失效。 * 设置桶保留策略后，如果新上传的对象未单独设置对象保留时间，则默认会继承桶保留时间，并自动进入锁定状态。在设置桶保留时间之前上传的对象，则不会主动继承该保留时间。 * 仅开启对象锁定功能，但未设置桶保留时间或对象保留时间，对象不会进入锁定状态，无法获得防删除和防覆盖保护。 ## **请求消息样式** ```JSON PUT /?object-lock HTTP/1.1 Host: bucketname.tos-cn-beijing.volces.com Date: GMT Date Authorization: authorization string { "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Days": 100, "Mode": "COMPLIANCE" } } } ``` ## **请求参数和消息头** 该请求使用的公共消息头，请参见[公共参数](/docs/6349/75044)。 |**名称** |**位置** |**参数类型** |**是否必选** |**示例值** |**说明** | |---|---|---|---|---|---| |object\-lock |Query |String |是 |\- |代表 PutBucketObjectLockConfiguration 请求的特殊标识。 | ## **请求元素** |**名称** |**参数类型** |**是否必选** |**示例值** |**说明** | |---|---|---|---|---| |ObjectLockEnabled |String |是 |Enabled |是否开启保留策略，取值仅为 `Enabled`，表示开启保留策略。 | |Rule |Object |否 |\- |桶保留策略规则。 | |DefaultRetention |Object |否 |\- |桶的默认保留策略。|\ | | | | |父节点： Rule。 | |Days |Integer |否 |1 |对象锁定天数，在指定天数内对象不能被删除或覆盖，以天为单位，取值范围为 1～36500 天。|\ | | | | |:::tip|\ | | | | |`Days` 和 `Years`参数只需设置其一。|\ | | | | |:::|\ | | | | |父节点：DefaultRetention | |Years |Integer |否 |1 |对象锁定年数，在指定年数内对象不能被删除或覆盖，以年为单位，取值范围为 1～100年，一年为 365 天。|\ | | | | |:::tip|\ | | | | |`Days` 和 `Years`参数只需设置其一。|\ | | | | |:::|\ | | | | |父节点：DefaultRetention | |Mode |String |否 |COMPLIANCE |保留策略模式，取值仅为 `COMPLIANCE`，表示合规模式，即任何用户在保留期内均不能删除或覆盖被锁定的对象。|\ | | | | |父节点：DefaultRetention | ## **响应消息头** 该请求返回公共响应消息头。 ## **响应元素** 该请求响应中无消息元素。 ## **请求示例 1** 开启对象锁定功能，并设置保留时间为 100 天。 ```JSON PUT /?object-lock HTTP/1.1 Host: bucketname.tos-cn-beijing.volces.com Date: Fri, 30 Jul 2021 13:59:18 GMT Authorization: authorization string { "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Days": 100, "Mode": "COMPLIANCE" } } } ``` ## 响应示例 1 ```JSON HTTP/1.1 200 OK x-tos-id-2: f91b0c03a01300c1-a444cd0 x-tos-request-id: f91b0c03a01300c1-a444cd0 Date: Fri, 30 Jul 2021 06:45:39 GMT server: TosServer Content-Length: 0 ``` ## **请求示例 2** 仅开启对象锁定功能，不设置保留时间。 ```JSON PUT /?object-lock HTTP/1.1 Host: bucketname.tos-cn-beijing.volces.com Date: Fri, 30 Jul 2021 13:59:18 GMT Authorization: authorization string { "ObjectLockEnabled": "Enabled" } ``` ## 响应示例 2 ```JSON HTTP/1.1 200 OK x-tos-id-2: f91b0c03a01300c1-a444ed0 x-tos-request-id: f91b0c03a01300c1-a444ed0 Date: Fri, 30 Jul 2021 06:45:39 GMT server: TosServer Content-Length: 0 ```

对象存储