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

设置桶级WORM保护策略

功能介绍

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

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

接口约束

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

方法定义

func (obsClient ObsClient) SetBucketWormConfiguration(input *SetBucketDirectColdAccessInput, extensions ...extensionOptions) (output *BaseModel, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*SetBucketWormConfigurationInput

必选

参数解释：

设置桶级WORM保护策略请求参数，详见SetBucketWormConfigurationInput。

extensions

extensionOptions

可选

参数解释：

桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。
表2 SetBucketWormConfigurationInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

ObjectLockConfiguration

ObjectLockConfiguration

必选

参数解释：

桶的多版本状态。

取值范围：

状态取值范围参见ObjectLockConfiguration。

默认取值：

无
表3 ObjectLockConfiguration

参数名称

参数类型

是否必选

描述

ObjectLockEnabled

string

可选

参数解释：

桶级WORM开关状态。

约束限制：

不涉及

取值范围：

Enabled：启用桶级WORM功能。

默认取值：

不涉及

Rule

*Rule

可选

参数解释：

桶级WORM策略。

约束限制：

ObjectLockEnabled为Enabled时必选，不携带则会清空当前配置的桶级默认WORM策略

取值范围：

请详见Rule。

默认取值：

不涉及
表4 Rule

参数名称

参数类型

是否必选

描述

DefaultRetention

*DefaultRetention

必选

参数解释：

桶级WORM策略。

约束限制：

不涉及

取值范围：

请详见表5。

默认取值：

不涉及
表5 DefaultRetention

参数名称

参数类型

是否必选

描述

Mode

string

必选

参数解释：

桶的WORM保护策略。

约束限制：

不涉及

取值范围：

COMPLIANCE：合规模式。

默认取值：

不涉及

Days

int

可选

参数解释：

保护天数。单位：天。

约束限制：

Days和Years只能有一个不为0，并且在规定取值范围内。

取值范围：

1~36500

默认取值：

不涉及

Years

int

可选

参数解释：

默认的保护年数，单位：年。

约束限制：

  • 一年实际上视为保护365天，不考虑闰年。
  • Days和Years只能有一个不为0，并且在规定取值范围内。

取值范围：

1~100

默认取值：

不涉及

返回结果说明

表6 返回结果列表

参数名称

参数类型

描述

output

*BaseModel

参数解释：

接口返回信息，详见BaseModel。

err

error

参数解释：

接口返回错误信息。
表7 BaseModel

参数名称

参数类型

描述

StatusCode

int

参数解释：

HTTP状态码。

约束限制：

无

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

RequestId

string

参数解释：

OBS服务端返回的请求ID。

约束限制：

无

取值范围：

无

默认取值：

无

ResponseHeaders

map[string][]string

参数解释：

HTTP响应头信息。

约束限制：

无

取值范围：

无

默认取值：

无

代码示例

本示例用于设置examplebucket桶级默认WORM策略。 
package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。
    securityToken := os.Getenv("SecurityToken")
    // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。
    endPoint := "https://obs.cn-north-4.myhuaweicloud.com"
    // 创建obsClient实例
    // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
    obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.SetBucketWormConfigurationInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定WORM策略
    input.ObjectLockConfiguration.ObjectLockEnabled = "Enabled"
    input.ObjectLockConfiguration.Rule = &obs.Rule{}
    input.ObjectLockConfiguration.Rule.DefaultRetention = &obs.DefaultRetention{}
    input.ObjectLockConfiguration.Rule.DefaultRetention.Mode = "COMPLIANCE"
    input.ObjectLockConfiguration.Rule.DefaultRetention.Days = 30
    // 配置桶级默认WORM策略
    output, err := obsClient.SetBucketWormConfiguration(bucketName)
    if err == nil {
	fmt.Printf("Set bucket(%s)'s WORM configuration successful!\n", bucketName)
	fmt.Printf("RequestId:%s\n", output.RequestId)
	return
    }
    fmt.Printf("Set bucket(%s)'s WORM configuration fail!\n", bucketName)
    if obsError, ok := err.(obs.ObsError); ok {
	fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
	fmt.Println(obsError.Error())
    } else {
	fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
	fmt.Println(err)
    }
}

相关链接

父主题： 桶级WORM保护策略

相关文档