# 配置对象级WORM保护策略(Python SDK)
#### 功能说明
开启了WORM开关的桶，上传的对象支持配置或修改对象保护期限。
- 如果上传对象时没有配置保护期限或自动应用桶级默认保护策略，您可以通过该操作配置对象保护期限。
- 如果上传对象时配置了保护期限或自动应用了默认保护期限，允许用户通过该操作延长保护期限。
- 对象保护期限仅允许修改，不允许删除。
 
#### 接口约束
- 您必须是桶拥有者或拥有配置对象级WORM保护策略的权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObjectRetention权限，如果使用桶策略则需授予PutObjectRetention权限。相关授权方式介绍可参见[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_0075.html)。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
 
#### 方法定义
```
ObsClient.putObjectRetention(bucketName, objectKey, mode, retainUntilDate, versionId, extensionHeaders)
```
#### 请求参数
表1请求参数列表 
| **参数名称**         | **参数类型** | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| bucketName       | str      | 必选       | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **默认取值：** 无 |
| objectKey        | str      | 必选       | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| mode             | str      | 必选       | **参数解释：** 对象的WORM保护策略。 **约束限制：** 不涉及 **取值范围：** COMPLIANCE：合规模式。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| retainUntilDate  | int      | 必选       | **参数解释：** 对象的保护期限。示例：1435728035000。 **约束限制：** - 时间戳格式，精确到毫秒级，如2015年7月1日13点20分35秒对应的值为1435728035000。  - 仅可延长不能缩短。   **取值范围：** 必须晚于当前时间。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| versionId        | str      | 可选       | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9。 **取值范围：** 长度为32的字符串。 **默认取值：** 无，如果不设置则默认指定最新版本的对象。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| extensionHeaders | dict     | 可选       | **参数解释：** 接口的拓展头域。 **取值范围：** 参考[自定义头域](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1305.html)。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
   
#### 返回结果
表2返回结果 
| **类型**                                       | **说明**                                            |
|:---|:---|
| [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桶内的exampleobject对象的WORM保护期限。
```
import os
import time
import traceback
from obs import ObsClient
# 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
# 运行本代码示例之前，请确保已设置环境变量AccessKeyID和SecretAccessKey
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值
obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) 
try: 
    bucket_name = 'examplebucket' 
    object_name = 'exampleobject' 
    # 对象的保护策略 
    mode = 'COMPLIANCE' 
    # 对象的保护期限，时间戳格式，精确到毫秒级，如2015年7月1日13点20分35秒对应的值为1435728035000, 该字段必须晚于当前时间，且仅可延长不能缩短 
    retain_until_date = (int(time.time()) + 60*60*24)*1000 
    # 对象的版本号。表示更改指定版本对象的WORM策略。不携带versionId参数则为最新版本 
    version_id = 'versionid' 
    # 设置对象保护期限 
    resp = obs_client.putObjectRetention(bucket_name, object_name, mode, retain_until_date) 
    # 返回码为2xx时，接口调用成功，否则接口调用失败 
    if resp.status < 300: 
        print('Put Object Retention Succeeded') 
        print('requestId:', resp.requestId) 
    else: 
        print('Put Object Retention Failed') 
        print('requestId:', resp.requestId) 
        print('errorCode:', resp.errorCode) 
        print('errorMessage:', resp.errorMessage) 
except Exception: 
    print('Put Object Retention Failed') 
    print(traceback.format_exc())
```