GetObjectRetention

更新时间:
复制为 MD 格式

调用GetObjectRetention接口获取指定Object版本的保留策略信息,包括保留模式和保留截止日期。

注意事项

  • 调用该接口前,Bucket必须已通过PutBucketObjectWormConfiguration接口开启对象级别保留策略(ObjectWorm)。

  • 调用该接口需要具备oss:GetObjectRetention权限。

  • 如果Object未设置保留策略且Bucket也未设置默认对象级别保留策略,则返回的Retention元素中ModeRetainUntilDate为空。

请求语法

GET /ObjectName?retention HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

请求参数

参数名称

类型

是否必选

示例值

描述

retention

不涉及

不涉及

固定请求参数,用于指定本次操作为获取对象保留策略信息。

versionId

字符串

CAEQNhiBgMDJgZCA0BYiIDc4MGZj****

Object的版本ID。如果不指定,则默认对最新版本的Object进行操作。

响应元素

名称

类型

示例值

描述

Retention

容器

不涉及

Object保留策略信息的容器。

子节点:Mode、RetainUntilDate

Mode

字符串

COMPLIANCE

Object的保留模式。COMPLIANCE表示合规模式。如果未设置保留策略,则该值为空。

父节点:Retention

RetainUntilDate

字符串

2026-10-11T00:00:00.000Z

Object的保留截止日期,ISO 8601格式。在此日期之前,该Object版本不允许被删除或覆盖写。如果未设置保留策略,则该值为空。

父节点:Retention

示例

  • 请求示例

    GET /exampleobject?retention&versionId=CAEQNhiBgMDJgZCA0BYiIDc4MGZj**** HTTP/1.1
    Date: Thu, 17 Mar 2026 11:18:32 GMT
    Host: examplebucket.oss-cn-hangzhou.aliyuncs.com
    Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20260317/cn-hangzhou/oss/aliyun_v4_request,Signature=****
  • 返回示例

    HTTP/1.1 200 OK
    x-oss-request-id: 5374A2880232A65C2300****
    Date: Thu, 17 Mar 2026 11:18:32 GMT
    Content-Type: application/xml
    Transfer-Encoding: chunked
    Server: AliyunOSS
    
    <?xml version="1.0" encoding="UTF-8"?>
    <Retention>
      <Mode>COMPLIANCE</Mode>
      <RetainUntilDate>2026-10-11T00:00:00.000Z</RetainUntilDate>
    </Retention>