功能描述
GET Bucket ObjectLockConfiguration 接口用于获取存储桶的对象锁定配置。
请求
请求示例
GET /?object-lock HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: 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><Mode>COMPLIANCE</Mode><Days>30</Days></DefaultRetention></Rule></ObjectLockConfiguration>
具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
ObjectLockConfiguration | 无 | 对象锁定配置 | Container |
ObjectLockEnabled | ObjectLockConfiguration | 是否开启对象锁定,仅支持传入 Enabled 。对象锁定开启后不支持关闭 | String |
Rule | ObjectLockConfiguration | 对象锁定规则,用于规定存储桶对象锁定默认周期和模式,该规则支持删除、修改,也可能为空 | Container |
DefaultRetention | ObjectLockConfiguration.Rule | 存储桶对象锁定默认周期和模式,未携带锁定头部的对象遵循桶配置设置保留期限 | Container |
Days | ObjectLockConfiguration.Rule.DefaultRetention | 对象锁定默认周期时长(范围为1-36500) | Int |
Mode | ObjectLockConfiguration.Rule.DefaultRetention | 对象锁定默认模式,仅支持枚举值 COMPLIANCE | Enum |
错误码
实际案例
案例一:获取未配置默认锁定模式和保留周期的对象锁定配置信息
请求
GET /?object-lock HTTP/1.1Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.comAuthorization: Auth String
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 180Connection: keep-aliveDate: Fri, 09 Dec 2022 08:31:25 GMTServer: tencent-cosx-cos-request-id: NjM5MmYyNWNfMzBkMDM4MGJfMmUzNzFfM****<ObjectLockConfiguration><ObjectLockEnabled>Enabled</ObjectLockEnabled></ObjectLockConfiguration>
案例二:获取已配置默认锁定模式和保留周期的对象锁定配置信息
请求
GET /?object-lock HTTP/1.1Host: examplebucket2-1250000000.cos.ap-beijing.myqcloud.comAuthorization: Auth String
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 180Connection: keep-aliveDate: Fri, 09 Dec 2022 08:31:25 GMTServer: tencent-cosx-cos-request-id: NjM5MmYyNWNfMzBkMDM4MGJfMmUzNzFfM****<ObjectLockConfiguration><ObjectLockEnabled>Enabled</ObjectLockEnabled><Rule><DefaultRetention><Mode>COMPLIANCE</Mode><Days>30</Days></DefaultRetention></Rule></ObjectLockConfiguration>