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

配置桶级默认WORM策略(C SDK)

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

功能介绍

OBS提供合规模式的WORM功能，当桶设置了WORM策略后，如果新上传的对象没有设置保护策略和保护期限，则其会自动应用桶级WORM策略。可通过本接口为指定桶配置默认保护策略和保护期限。

当您在桶内配置了桶级默认WORM策略以后，如果您在上传对象时没有指定保护策略和保护期限，则新上传的对象会自动应用桶级默认WORM策略。和配置对象级WORM保护策略不同的地方在于，对象级WORM保护策略需要您提供一个明确的时间，在这个时间之前对象都会受到保护，桶级默认WORM策略则要求您提供一个保护期限，实际上对象受到保护的时间点为其上传时间+您指定的保护期限。

接口约束

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

    WORM保护是基于对象版本号的，配置WORM的版本受到WORM保护，没有配置WORM的版本可正常删除。例如，test.txt 001受到WORM保护。此时再次上传同名文件，产生新的对象版本test.txt 002，test.txt 002并未配置WORM，那么test.txt 002就不受保护可以正常删除。当您下载对象时，不指定版本号下载的是最新对象，也就是test.txt 002。

  • 处于保护中的对象不会被生命周期删除，但是能正常进行存储类别转换。受保护的对象不再受保护后，如果满足生命周期过期规则，将会被系统删除。
  • 桶级WORM开关一旦打开，则无法为该桶禁用桶级WORM开关 ，也无法暂停桶的版本控制，但可以禁用桶级默认WORM策略。
  • 在客户销户、欠费超期情况下，WORM未到期数据会被删除而不做保留。
  • 不支持迁移场景。
  • WORM不阻止修改对象元数据。
  • 并行文件系统不支持WORM。
  • 策略目前仅支持设置为合规模式"COMPLIANCE"
  • 支持设置的保留期限为1天-100*365天或1年~100年。
  • 您可以修改甚至清空桶级默认WORM策略，但这仅对修改后上传的对象生效，修改前上传的对象的保护状态不受影响。
  • 多段上传的对象在合并前不受保护，合并后受桶级默认对象策略保护，您可以在其合并后单独为其配置对象级WORM保护策略。

方法定义

void set_bucket_object_lock_configuration(const obs_options *options,
    obs_bucket_object_lock_configuration *object_lock_config,
    obs_response_handler *handler, void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释：

请求桶的上下文，通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。

约束限制：

无

取值范围：

无

默认取值：

无

object_lock_config

表2 obs_bucket_object_lock_configuration*

必选

参数解释：

桶对象锁定配置结构体。

约束限制：

无

取值范围：

无

默认取值：

无

handler

obs_response_handler *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

可选

参数解释：

用户自定义回调数据。

约束限制：

无

取值范围：

无

默认取值：

无
表2 obs_bucket_object_lock_configuration

参数名称

参数类型

是否必选

描述

object_lock_enabled

char *

必选

参数解释：

WORM开关状态。

约束限制：

无

取值范围：

Enabled：启用

默认取值：

无

default_retention

表3 obs_worm_default_retention*

可选

参数解释：

默认保留策略，定义新上传对象的默认保护期限和保护模式。为NULL时表示清空默认保留策略。

约束限制：

无

取值范围：

无

默认取值：

无
表3 obs_worm_default_retention

参数名称

参数类型

是否必选

描述

mode

char *

必选

参数解释：

保护模式。

约束限制：

无

取值范围：

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

默认取值：

无

days

unsigned int

可选

参数解释：

保护天数。

约束限制：

与years二选一，不可同时设置。

取值范围：

1~36500。

默认取值：

0

years

unsigned int

可选

参数解释：

保护年数。

约束限制：

与days二选一，不可同时设置。

取值范围：

1~100。

默认取值：

0

代码示例

以下示例展示如何配置桶级默认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
44
45
 
#include "eSDKOBS.h"
#include <stdio.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";
    // 设置默认保留策略：合规模式，保留365天
    obs_worm_default_retention retention = {0};
    retention.mode = "COMPLIANCE";
    retention.days = 365;
    retention.years = 0;
    // 设置桶对象锁定配置
    obs_bucket_object_lock_configuration lock_config = {0};
    lock_config.object_lock_enabled = "Enabled";
    lock_config.default_retention = &retention;
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_status ret_status = OBS_STATUS_BUTT;
    set_bucket_object_lock_configuration(&options, &lock_config, &response_handler, &ret_status);
    if (OBS_STATUS_OK == ret_status) {
        printf("set bucket object lock configuration successfully.\n");
    } else {
        printf("set bucket object lock configuration 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); }
}

相关链接

相关文档