租户端 存储 对象存储（COS） COS API参考 GET Bucket ObjectLockConfiguration

GET Bucket ObjectLockConfiguration

最近更新时间: 2024-06-12 15:06:00

功能描述

COS 支持为已存在的存储桶设置对象锁定。GET Bucket ObjectLockConfiguration 接口用于获取已生效的对象锁定配置。

请求

请求示例

GET /?object-lock HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String

说明：

  • Host: <BucketName-APPID>.cos.<Region>.myqcloud.com，其中 <BucketName-APPID> 为带 APPID 后缀的存储桶名字，例如 examplebucket-1250000000，<Region> 为 COS 的可用地域。
  • Authorization: Auth String（详情请参见 请求签名 文档）。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求的请求体为空。

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

<?xml version="1.0" encoding="UTF-8" ?>
<ObjectLockConfiguration>
      <ObjectLockEnabled>Enabled</ObjectLockEnabled> 
      <Rule> 
           <DefaultRetention>
                 <Days>30</Days> 
           </DefaultRetention> 
      </Rule> 
</ObjectLockConfiguration>

具体数据描述如下：

节点名称（关键字） 父节点 描述 类型
ObjectLockConfiguration 无 对象锁定配置 Container
ObjectLockEnabled ObjectLockConfiguration 是否开启对象锁定 String
Rule ObjectLockConfiguration 对象锁定规则 Containers
DefaultRetention ObjectLockConfiguration.Rule 对象锁定默认周期 Containers
Days ObjectLockConfiguration.Rule.DefaultRetention 对象锁定默认周期时长（范围为1-36500天） Int

错误码

此接口遵循统一的错误响应和错误码，详情请参见 错误码 文档。

实际案例

请求

以下示例表示获取存储桶 examplebucket-1250000000 的对象锁定配置。 

GET /?object-lock= HTTP/1.1
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Authorization: Auth String

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 180
Connection: keep-alive
Date: Fri, 09 Dec 2022 08:31:25 GMT
Server: tencent-cos
x-cos-request-id: NjM5MmYyNWNfMzBkMDM4MGJfMmUzNzFfM****

<ObjectLockConfiguration>
    <ObjectLockEnabled>Enabled</ObjectLockEnabled>
    <Rule>
        <DefaultRetention>
            <Days>1</Days>
        </DefaultRetention>
    </Rule>
</ObjectLockConfiguration>