# 设置桶级默认WORM策略(Python SDK)
#### 功能介绍
本接口用于为指定桶配置默认保护策略和保护期限。
当您在桶内配置了桶级默认WORM策略以后，如果您在上传对象时没有指定保护策略和保护期限，则新上传的对象会自动应用桶级默认WORM策略。和配置对象级WORM保护策略不同的地方在于，对象级WORM保护策略需要您提供一个明确的时间，在这个时间之前对象都会受到保护，桶级默认WORM策略则要求您提供一个保护期限，实际上对象受到保护的时间点为其上传时间+您指定的保护期限。
![](https://support.huaweicloud.com/sdk-python-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 您可以修改甚至清空桶级默认WORM策略，但这仅对修改后上传的对象生效，修改前上传的对象的保护状态不受影响。
- 多段上传的对象在合并前不受保护，合并后受桶级默认对象策略保护，您可以在其合并后单独为其配置对象级WORM保护策略。
 
#### 接口约束
- 您必须是桶拥有者或者拥有配置桶级默认WORM策略权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketObjectLockConfiguration权限，如果使用桶策略则需授予PutBucketObjectLockConfiguration权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。

- 策略目前仅支持设置为合规模式"COMPLIANCE"
- 支持设置的保留期限为1天-100\*365天或1年\~100年。

- OBS支持的region以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
 
#### 方法定义
ObsClient.setBucketObjectLock(bucketName, objectLockConfiguration, extensionHeaders)
#### 请求参数说明
| **参数名称**                | **参数类型**                                                                         | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| bucketName              | str                                                                              | 必选       | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **默认取值：** 无 |
| objectLockConfiguration | [表1 ObjectLockConfiguration] | 必选       | **参数解释** **：** 桶级WORM配置，详见[表1 ObjectLockConfiguration]。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| extensionHeaders        | dict                                                                             | 可选       | **参数解释：** 接口的拓展头域。 **取值范围：** 参考[自定义头域](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1305.html)。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
   
 表1ObjectLockConfiguration 
| **参数名称**          | **参数类型**                                             | **是否必选**                                            | **描述**                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| objectLockEnabled | str                                                  | 可选                                                  | **参数解释：** 桶级WORM开关状态。 **约束限制：** 不涉及 **取值范围：** Enabled：启用桶级WORM功能。 **默认取值：** 不涉及                                                          |
| rule              | [表2 ObjectLockRule] | ObjectLockEnabled为Enabled时必选，不携带则会清空当前配置的桶级默认WORM策略 | **参数解释：** 桶级WORM策略的规则。 **约束限制：** 不携带则会清空当前配置的桶级默认WORM策略 **取值范围：** 请详见[表2 ObjectLockRule]。 **默认取值：** 不涉及 |
   
 表2ObjectLockRule 
| **参数名称** | **参数类型** | **是否必选**                  | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| days     | int      | 和years二选一，必须选择其中一个且不能同时指定 | **参数解释：** 保护天数。单位：天。 **约束限制：** days和years只能有一个不为0，并且在规定取值范围内。 **取值范围：** 1\~36500 **默认取值：** 不涉及                                                                                                                                                         |
| years    | int      | 和days二选一，必须选择其中一个且不能同时指定  | **参数解释：** 默认的保护年数，单位：年。 **约束限制：** - 一年实际上视为保护365天，不考虑闰年。  - days和years只能有一个不为0，并且在规定取值范围内。   **取值范围：** 1\~100 **默认取值：** 不涉及 |
| mode     | str      | 可选                        | **参数解释：** 桶的WORM保护策略。 **约束限制：** 不涉及 **取值范围：** COMPLIANCE：合规模式。 **默认取值：** COMPLIANCE                                                                                                                                                                                |
   
#### 返回结果说明
| **类型**                                         | **说明**                                              |
|:---|:---|
| [GetResult] | **参数解释：** SDK公共结果对象。 |
   
 表3GetResult 
| **参数名称**     | **参数类型** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| status       | int      | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 |
| reason       | str      | **参数解释：** HTTP文本描述。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                 |
| errorCode    | str      | **参数解释：** OBS服务端错误码，当status参数小于300时为空。 **默认取值：** 无                                                                                                                                                                                                                                                                                                 |
| errorMessage | str      | **参数解释：** OBS服务端错误描述，当status参数小于300时为空。 **默认取值：** 无                                                                                                                                                                                                                                                                                                  |
| requestId    | str      | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无                                                                                                                                                                                                                                                                                                           |
| indicator    | str      | **参数解释：** OBS服务端返回的错误定位码。 **默认取值：** 无                                                                                                                                                                                                                                                                                                             |
| hostId       | str      | **参数解释：** 请求的服务端ID，当status参数小于300时为空。 **默认取值：** 无                                                                                                                                                                                                                                                                                                |
| resource     | str      | **参数解释：** 发生错误时相关的桶或对象，当status参数小于300时为空。 **默认取值：** 无                                                                                                                                                                                                                                                                                            |
| header       | list     | **参数解释：** 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 **默认取值：** 无                                                                                                                                                                                                                                                                                       |
| body         | object   | **参数解释：** 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见"桶相关接口"章节和"对象相关接口"章节的详细描述。 **默认取值：** 无                                                                                                                                                                                                                                                    |
   
#### 代码样例
本示例用于设置examplebucket桶的默认WORM策略。
```
from obs import ObsClient, ObjectLockRule, ObjectLockConfiguration
import os
import traceback
# 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucket_name = 'examplebucket'
    rule = ObjectLockRule(
        # 保护天数/年数，Days和Years只能有一个不为0。
        days=60
        # years=1
    )
    config = ObjectLockConfiguration(objectLockEnabled="Enabled", rule=rule)
    # 设置桶的默认WORM策略
    resp = obsClient.setBucketObjectLock(bucket_name, config)
    # 不携带config调用setBucketObjectLock接口，表示清空当前的桶级默认WORM策略配置
    # resp = obsClient.setBucketObjectLock(bucket_name)
    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Set Bucket ObjectLock Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Bucket ObjectLock Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except Exception:
    print('Set Bucket ObjectLock Failed')
    print(traceback.format_exc())
```