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

配置对象级WORM保护策略

功能介绍

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

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

接口约束

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

方法定义

func (obsClient ObsClient) PutObjectRetention(input *PutObjectRetentionInput, extensions ...extensionOptions) (output *BaseModel, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*PutObjectRetentionInput

必选

参数解释：

设置对象级WORM保护策略请求参数，详见PutObjectRetentionInput。

extensions

extensionOptions

可选

参数解释：

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

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

Key

string

必选

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

VersionId

string

可选

参数解释：

对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。

取值范围：

长度为32的字符串。

默认取值：

无，如果不设置则默认删除最新版本的对象。

RetentionMode

string

必选

参数解释：

对象的保护期限，时间戳格式，精确到毫秒级，如2015年7月1日13点20分35秒对应的值为1435728035000。

示例：1435728035000

约束限制：

该字段必须晚于当前时间，且仅可延长不能缩短。

取值范围：

不涉及

默认取值：

不涉及

RetainUntilDate

int64

必选

参数解释：

对象的保护策略。

约束限制：

不涉及

取值范围：

COMPLIANCE：合规模式

默认取值：

不涉及

返回结果说明

表3 返回结果列表

参数名称

参数类型

描述

output

*BaseModel

参数解释：

接口返回信息，详见BaseModel。

err

error

参数解释：

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

参数名称

参数类型

描述

StatusCode

int

参数解释：

HTTP状态码。

约束限制：

无

取值范围：

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

默认取值：

无

RequestId

string

参数解释：

OBS服务端返回的请求ID。

约束限制：

无

取值范围：

无

默认取值：

无

ResponseHeaders

map[string][]string

参数解释：

HTTP响应头信息。

约束限制：

无

取值范围：

无

默认取值：

无

代码示例

本示例用于配置对象级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.PutObjectRetentionInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定对象，此处以 example/objectname 为例。
    input.Key = "example/objectname"
    input.RetentionMode = string(obs.WormRetentionModeCompliance)
    input.RetainUntilDate = retainUntilDate
    // 配置对象级WORM保护策略
    output, err := obsClient.PutObjectRetention(bucketName)
    if err == nil {
	fmt.Printf("Set object retention successfully!\n")
	fmt.Printf("RequestId:%s\n", output.RequestId)
	return
    }
    fmt.Printf("Set object retention fail!\n")
    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)
    }
}

相关链接

相关文档