文档首页/ 对象存储服务 OBS/ SDK参考/ C/ 对象相关接口(C SDK)/ 配置对象级WORM保护策略(C SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

配置对象级WORM保护策略(C SDK)

开发过程中，您有任何问题可以在GitHub上提交issue，或者在华为云对象存储服务论坛中发帖求助。

功能说明

开启了WORM开关的桶，上传的对象支持配置或修改对象保护期限。

  • 如果上传对象时没有配置保护期限或自动应用桶级默认保护策略，您可以通过本接口配置对象保护期限。
  • 如果上传对象时配置了保护期限或自动应用了默认保护期限，允许用户通过本接口延长保护期限。
  • 对象保护期限仅允许修改，不允许删除。

接口约束

  • 您必须是桶拥有者或拥有设置桶级WORM保护策略的权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketObjectLockConfiguration权限，如果使用桶策略则需授予PutBucketObjectLockConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

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*

必选

参数解释：

请求桶的上下文，通过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 *

必选

参数解释：

回调结构体，结构体内所有成员都是回调函数的指针，用于设置处理接口响应数据的回调函数。您可以通过设置回调函数，把服务端的响应数据复制到您的自定义回调数据callback_data中。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

可选

参数解释：

用户自定义回调数据。

约束限制：

无

取值范围：

无

默认取值：

无
表2 obs_object_retention

参数名称

参数类型

是否必选

描述

mode

char *

必选

参数解释：

保护模式。

约束限制：

无

取值范围：

COMPLIANCE：合规模式，任何用户都无法在保护期内删除受保护的对象

默认取值：

无

retain_until_date

int64_t

必选

参数解释：

保护截止时间戳，单位为毫秒。保护到期后，对象不再受WORM保护。

约束限制：

合规模式下，保护期限只能延长不能缩短。

取值范围：

大于当前时间的毫秒级时间戳。

默认取值：

无

代码示例

以下示例展示如何配置对象级WORM保护策略： 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
#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天
    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保护策略。
  • 配置对象级WORM保护策略过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。

相关文档