文档中心

对象存储

请输入

对象 WORM

PutObjectRetention

功能描述

此接口用于创建或修改对象的保留策略。

前提条件

使用 PutObjectRetention 接口创建对象的保留策略前，您必须先开启对象锁定功能，具体操作，请参见设置对象保留时间。

注意事项

在存储桶开启了版本控制功能的情况下，若不指定版本号，则会为最新版本对象设置保留策略。

对象保留时间仅支持延长，不支持缩短。

请求消息样式

PUT /objectname?retention HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: GMT Date​
Authorization: authorization string​
​
{   ​
    "Mode": "COMPLIANCE",​
    "RetainUntilDate": "2025-07-22T00:00:00Z"​
}​

请求参数和消息头

该请求使用的公共消息头，请参见公共参数。

名称	位置	参数类型	是否必选	示例值	说明
retention	Query	String	是	-	代表 PutObjectRetention 请求的特殊标识。
versionId	Query	String	否	57AF1A32CECB56721267	对象的版本号。

请求元素

名称	参数类型	是否必选	示例值	说明
Mode	String	是	COMPLIANCE	保留策略模式，取值仅为 COMPLIANCE，表示合规模式，即任何用户在保留期内均不能删除或覆盖被锁定的对象。
RetainUntilDate	String	是	2025-01-01T00:00:00Z	保留时间，用于指定对象不能删除或覆盖的截止日期。时间格式为 YYYY-MM-DDTHH:mm:ssZ。

响应消息头

该请求返回公共响应消息头。

响应元素

该请求响应中无消息元素。

请求示例

PUT /objectname?retention HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 13:59:18 GMT​
Authorization: authorization string​
​
{   ​
    "Mode": "COMPLIANCE",​
    "RetainUntilDate": "2025-07-22T00:00:00Z"​
}​

响应示例

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​

最近更新时间：2025.09.26 15:50:15

这个页面对您有帮助吗？

有用

无用