# 配置对象级WORM保护策略(C SDK)
![](https://support.huaweicloud.com/sdk-c-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-c-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。
#### 功能说明
开启了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)。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
 
#### 方法定义
```
void set_object_retention(const obs_options *options, const char *key,
    obs_object_retention *retention, const char *version_id,
    obs_response_handler *handler, void *callback_data);
```
#### 请求参数
表1请求参数列表 
| 参数名称          | 参数类型                                                                                                                  | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| options       | const [obs_options](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0085.html#obs_20_0085__table9681927859)\*   | 必选   | **参数解释：** 请求桶的上下文，通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                      |
| key           | const char \*                                                                                                         | 必选   | **参数解释：** 对象名。对象名在桶中唯一标识一个对象，即桶内不能存在两个相同的对象名。 **约束限制：** 无 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无                                                                                  |
| retention     | [表2 obs_object_retention]\*                                                         | 必选   | **参数解释：** 对象WORM保护策略结构体。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                                                                                                          |
| version_id    | const char \*                                                                                                         | 可选   | **参数解释：** 对象版本号。开启版本控制后，指定对象的版本号。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无，默认操作最新版本的对象。                                                                                                    |
| handler       | [obs_response_handler](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0087.html#obs_20_0087__table53755070) \* | 必选   | **参数解释：** 回调结构体，结构体内所有成员都是回调函数的指针，用于设置处理接口响应数据的回调函数。您可以通过设置回调函数，把服务端的响应数据复制到您的自定义回调数据callback_data中。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 |
| callback_data | void \*                                                                                                               | 可选   | **参数解释：** 用户自定义回调数据。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                                                                                                                 |
   
 表2obs_object_retention 
| 参数名称              | 参数类型    | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| mode              | char \* | 必选   | **参数解释：** 保护模式。 **约束限制：** 无 **取值范围：** COMPLIANCE：合规模式，任何用户都无法在保护期内删除受保护的对象 **默认取值：** 无                      |
| retain_until_date | int64_t | 必选   | **参数解释：** 保护截止时间戳，单位为毫秒。保护到期后，对象不再受WORM保护。 **约束限制：** 合规模式下，保护期限只能延长不能缩短。 **取值范围：** 大于当前时间的毫秒级时间戳。 **默认取值：** 无 |
   
#### 代码示例
以下示例展示如何配置对象级WORM保护策略：
```
#include "eSDKOBS.h"
#include <stdio.h>
#include <time.h>
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data);
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data);
int main()
{
    obs_initialize(OBS_INIT_ALL);
    obs_options options;
    init_obs_options(&options);
   // host_name填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。
    options.bucket_options.host_name = "obs.cn-north-4.myhuaweicloud.com";
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
    // 本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY。
    options.bucket_options.access_key = getenv("ACCESS_KEY_ID");
    options.bucket_options.secret_access_key = getenv("SECRET_ACCESS_KEY");
    options.bucket_options.bucket_name = "example-bucket-name";
    // 设置对象级WORM保护策略：合规模式，保护1天
    // 注意: 合规模式下保留期只能延长或保持不变, 不能缩短。
    // 若对象已有保留期, 且其截止时间晚于本次要设置的 retain_until_date,
    // 则本次设置会被服务端拒绝(缩短保留期不允许)。应确保新值不早于已有保留期。
    time_t now = time(NULL);
    int64_t retain_until_date = (int64_t)now * 1000 + (1 * 24 * 60 * 60 * 1000LL);
    obs_object_retention retention = {0};
    retention.mode = "COMPLIANCE";
    retention.retain_until_date = retain_until_date;
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_status ret_status = OBS_STATUS_BUTT;
    set_object_retention(&options, "objectname", &retention, NULL, &response_handler, &ret_status);
    if (OBS_STATUS_OK == ret_status) {
        printf("set object retention successfully.\n");
    } else {
        printf("set object retention failed(%s).\n", obs_get_status_name(ret_status));
    }
    obs_deinitialize();
}
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data)
{
    (void)properties; (void)callback_data;
    return OBS_STATUS_OK;
}
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data)
{
    if (callback_data) { *(obs_status*)callback_data = status; }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}
```
#### 相关链接
- 关于配置对象级WORM保护策略的API说明，请参见[配置对象级WORM保护策略](https://support.huaweicloud.com/api-obs/obs_04_0166.html)。
- 配置对象级WORM保护策略过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。