文档首页/ 对象存储服务 OBS/ API参考/ API/ 桶的高级配置/ 获取桶级默认WORM策略-GetBucketObjectLock
更新时间:2025-12-18 GMT+08:00
分享

获取桶级默认WORM策略-GetBucketObjectLock

功能介绍

获取该桶设置的桶级默认WORM策略。

要正确执行此操作,需要确保操作者有GetBucketObjectLockConfiguration权限。默认情况下只有桶的所有者可以执行此操作,也可以通过设置桶策略或用户策略授权给其他用户。

如果您打开了桶级WORM开关,但从未配置过桶级默认WORM策略,您依然可以使用此接口查看开关的打开情况。

授权信息

您必须是桶拥有者或拥有获取桶级默认WORM策略的权限,才能调用本接口,建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别

  • 如果使用IAM授权,那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种,并配置相应权限:
    • 如果使用角色与策略授权(旧版IAM,即IAM v3接口),需具备obs:bucket:GetBucketObjectLockConfiguration权限,授权操作请参见创建IAM自定义策略
    • 如果使用身份策略授权(新版IAM,即IAM v5接口),如下表所示,需具备obs:bucket:getBucketObjectLockConfiguration权限,授权操作请参见创建IAM自定义身份策略

      授权项

      Action

      访问级别

      Access Level

      资源类型(*为必须)

      Resource Type (*: required)

      条件键

      Condition Key

      别名

      Alias

      依赖的授权项

      Dependencies

      obs:bucket:getBucketObjectLockConfiguration

      Read

      bucket *

      -

      -

      -

      • obs:EpochTime
      • obs:SourceIp
      • obs:TlsVersion
      • obs:CustomDomain
  • 如果使用桶策略进行授权,需具备obs:bucket:GetBucketObjectLockConfiguration权限,具体操作请参见自定义创建桶策略

请求消息样式

GET /?object-lock HTTP/1.1
Host: bucketname.obs.cn-north-4.myhuaweicloud.com
Date: date
Authorization: authorization
Content-Type: application/xml
Content-Length: length

请求消息参数

该请求消息中不使用消息参数。

请求消息头

该请求使用公共消息头,具体参见表3

请求消息元素

该请求消息中不使用消息元素。

响应消息样式

HTTP/1.1 status_code
Date: date
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
    <ObjectLockEnabled>Enabled</ObjectLockEnabled>
    <Rule>
       <DefaultRetention>
          <Days>integer</Days>
          <Mode>COMPLIANCE</Mode>
          <Years>integer</Years>
       </DefaultRetention>
    </Rule>
</ObjectLockConfiguration>

响应消息头

该请求的响应消息使用公共消息头,具体请参考表1

响应消息元素

在此请求返回的响应消息体中包含的桶级默认WORM策略元素如下表1描述。

表1 桶级默认WORM策略元素

参数名称

参数类型

描述

ObjectLockConfiguration

Container

参数解释:

桶级WORM配置的容器,ObjectLockConfiguration是ObjectLockEnabled和Rule的父节点。

取值范围:

请详见表2

表2 ObjectLockConfiguration参数说明

参数名称

参数类型

描述

ObjectLockEnabled

String

参数解释:

桶级WORM开关状态。

取值范围:

Enabled:启用桶级WORM功能。

Rule

Container

参数解释:

桶级WORM策略的规则容器。如果从未配置过桶级默认WORM策略,则返回中不会包含此部分。Rule是DefaultRetention的父节点。

取值范围:

请详见表3

表3 Rule参数说明

参数名称

参数类型

描述

DefaultRetention

Container

参数解释:

桶级默认WORM策略的容器,DefaultRetention是Mode、Days、Years的父节点。

取值范围:

请详见表4

表4 DefaultRetention参数说明

参数名称

参数类型

描述

Mode

String

参数解释:

默认的保护策略。

取值范围:

COMPLIANCE:合规模式。

Days

Integer

参数解释:

默认的保护天数。单位:天。

取值范围:

1~36500

Years

Integer

参数解释:

默认的保护年数,单位:年。

取值范围:

1~100

错误响应消息

此请求可能的特殊错误如下表5描述。

表5 错误响应消息

错误码

描述

HTTP状态码

InvalidRequest

目标桶没有开启桶级WORM开关

400

其余错误已经包含在表2中。

请求示例 1

打开了桶级WORM开关,未配置桶级默认WORM策略的情况

GET /?object-lock HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 02:25:05 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw=
Content-Length: 0

响应示例 1

HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016435CE298386946AE4C482
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
Date: WED, 01 Jul 2015 02:25:06 GMT
Content-Length: 157

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>  <ObjectLockEnabled>Enabled</ObjectLockEnabled>
</ObjectLockConfiguration>

请求示例 2

打开了桶级WORM开关,且配置了桶级默认WORM策略的情况:

GET /?object-lock HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 02:25:05 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw=
Content-Length: 0

响应示例 2

HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016435CE298386946AE4C482
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
Date: WED, 01 Jul 2015 02:25:06 GMT
Content-Length: 157

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ObjectLockConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
  <ObjectLockEnabled>Enabled</ObjectLockEnabled>
  <Rule>
    <DefaultRetention>
      <Mode>COMPLIANCE</Mode>
      <Days>10</Days>
      <Years>0</Years>
    </DefaultRetention>
  </Rule>
</ObjectLockConfiguration>

相关文档