# 获取桶级默认WORM策略-GetBucketObjectLock #### 功能介绍 当桶设置了桶级默认WORM策略，可以通过本接口获取该桶的桶级默认WORM策略。了解更多桶级默认WORM策略相关信息，请参见[配置对象锁定（WORM）防止对象被更改或删除](https://support.huaweicloud.com/usermanual-obs/obs_03_0718.html)。 ![](https://support.huaweicloud.com/api-obs/public_sys-resources/note_3.0-zh-cn.png) 如果您打开了桶级WORM开关，但从未配置过桶级默认WORM策略，您依然可以使用此接口查看开关的打开情况。 #### 接口约束 - 开启桶级WORM开关的桶暂不支持跨区域复制能力。 - 在客户销户、欠费超期情况下，WORM未到期数据会被删除而不做保留。 - 不支持迁移场景。 - WORM不阻止修改对象元数据。 - 并行文件系统不支持WORM。 #### 授权信息 您必须是桶拥有者或拥有获取桶级默认WORM策略的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见[OBS不同权限控制方式的区别](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)。 - 如果使用**IAM授权** ，那么请在"角色与策略授权"、"身份策略授权"两种IAM授权方式中选择一种，并配置相应权限： - 如果使用**角色与策略授权** （旧版IAM，即IAM v3接口），需具备**obs:bucket:GetBucketObjectLockConfiguration** 权限，授权操作请参见[创建IAM自定义策略](https://support.huaweicloud.com/usermanual-iam/iam_01_0605.html)。 - 如果使用**身份策略授权** （新版IAM，即IAM v5接口），如下表所示，需具备**obs:bucket:getBucketObjectLockConfiguration** 权限，授权操作请参见[创建IAM自定义身份策略](https://support.huaweicloud.com/usermanual-iam5/iam_01_0917.html)。 | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | [条件键](https://support.huaweicloud.com/api-obs/obs_04_0112.html#ZH-CN_TOPIC_0000002375307974__condition_table) Condition Key | [别名](https://support.huaweicloud.com/iam5_faq/iam_01_1103.html) Alias | 依赖的授权项 Dependencies | |:---|:---|:---|:---|:---|:---| | obs:bucket:getBucketObjectLockConfiguration | Read | bucket \* | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) - [g:ResourceTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) | - | - | | obs:bucket:getBucketObjectLockConfiguration | Read | - | - obs:EpochTime - obs:SourceIp - obs:TlsVersion - obs:CustomDomain | - | - | - 如果使用**桶策略** 进行授权，需具备**obs:bucket:GetBucketObjectLockConfiguration** 权限，具体操作请参见[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 #### URI GET / #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-obs/obs_04_0006.html)。调用前需要先[计算API签名](https://support.huaweicloud.com/api-obs/obs_04_0009.html)，并将签名添加到请求中。 您还可以使用[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/OBS/doc?api=GetBucketObjectLock)在线调试接口。 #### 请求消息样式 ``` 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 ``` #### URI参数（URI Parameters） 该请求消息中不使用消息参数。 #### 请求头参数（Request headers） 该请求使用公共请求头，具体参见[表3](https://support.huaweicloud.com/api-obs/obs_04_0007.html#ZH-CN_TOPIC_0136436606__table25197309)。 #### 请求体参数（Request body） 该请求消息中不带请求体参数。 #### 响应消息样式 ``` HTTP/1.1 status_code Date: date Content-Type: application/xml Content-Length: length Enabled integer COMPLIANCE integer ``` #### 响应头 (Response Headers) 该请求的响应消息使用公共响应头，具体请参考[表1](https://support.huaweicloud.com/api-obs/obs_04_0013.html#ZH-CN_TOPIC_0173612084__d0e686)。 #### 响应体 (Response Body) 在此请求返回的响应消息体中包含的桶级默认WORM策略元素如下[表1]描述。 表1桶级默认WORM策略元素 | 参数名称 | 参数类型 | 描述 | |:---|:---|:---| | ObjectLockConfiguration | Container | **参数解释：** 桶级WORM配置的容器，ObjectLockConfiguration是ObjectLockEnabled和Rule的父节点，请详见[表2]。 | 表2ObjectLockConfiguration参数说明 | 参数名称 | 参数类型 | 描述 | |:---|:---|:---| | ObjectLockEnabled | String | **参数解释：** 桶级WORM开关状态。**Enabled**表示启用桶级WORM功能。 | | Rule | Container | **参数解释：** 桶级WORM策略的规则容器。如果从未配置过桶级默认WORM策略，则返回中不会包含此部分。Rule是DefaultRetention的父节点，请详见[表3]。 | 表3Rule参数说明 | 参数名称 | 参数类型 | 描述 | |:---|:---|:---| | DefaultRetention | Container | **参数解释：** 桶级默认WORM策略的容器，DefaultRetention是Mode、Days、Years的父节点。 **取值范围：** 请详见[表4]。 | 表4DefaultRetention参数说明 | 参数名称 | 参数类型 | 描述 | |:---|:---|:---| | Mode | String | **参数解释：** 默认的保护策略。 **取值范围：** COMPLIANCE：合规模式。 | | Days | Integer | **参数解释：** 默认的保护天数。单位：天。 **取值范围：** 1\~36500（100\*365） | | Years | Integer | **参数解释：** 默认的保护年数，单位：年。 **取值范围：** 1\~100 | #### 错误响应消息 此请求可能的特殊错误如下[表5]描述。 表5错误响应消息 | 错误码 | 描述 | HTTP状态码 | |:---|:---|:---| | InvalidRequest | 目标桶没有开启桶级WORM开关 | 400 | 其余错误已包含在[错误码概述](https://support.huaweicloud.com/api-obs/obs_04_0115.html)中。 #### 请求示例 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 Enabled ``` #### 请求示例 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 Enabled COMPLIANCE 10 ``` #### 相关文档 - 了解更多桶级默认WORM策略相关信息，请参见[配置对象锁定（WORM）防止对象被更改或删除](https://support.huaweicloud.com/usermanual-obs/obs_03_0718.html)。 - API操作涉及的计费项参见[计费项](https://support.huaweicloud.com/price-obs/obs_42_0002.html)。