全部產品
Search
文件中心

Object Storage Service:GetObjectRetention

更新時間:Apr 01, 2026

調用GetObjectRetention介面擷取指定Object版本的保留原則資訊,包括保留模式和保留到期日。

注意事項

  • 調用該介面前,Bucket必須已通過PutBucketObjectWormConfiguration介面開啟對象層級保留原則(ObjectWorm)。

  • 調用該介面需要具備oss:GetObjectRetention許可權。

  • 如果Object未設定保留原則且Bucket也未設定預設對象層級保留原則,則返回的Retention元素中Mode和RetainUntilDate為空白。

請求文法

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>