文档首页/ 对象存储服务 OBS/ SDK参考/ Go/ 桶相关接口(Go SDK)/ 设置桶的生命周期配置(Go SDK)
更新时间：2024-12-09 GMT+08:00
查看PDF
分享

设置桶的生命周期配置(Go SDK)

功能介绍

OBS支持用户配置指定的规则，实现定时删除桶中的对象或者定时转换对象的存储类别，从而节省存储费用，更多生命周期相关信息请参见生命周期管理。

调用设置桶的生命周期配置接口，您可以为指定桶设置生命周期策略。

  • 对象生命周期到期以后，对象将会永久删除，无法恢复。
  • 归档存储不支持多AZ，因此不支持使用生命周期的存储类别转换功能，将多AZ的桶或对象转化为归档存储。
  • 低频访问存储的最低存储时间为30天，归档存储的最低存储时间为90天。如果对象经过转换，归档存储时间少于最低存储时间，需要补足剩余天数的存储费用。

接口约束

  • 单个桶的生命周期规则条数没有限制，但一个桶中所有生命周期规则的XML描述总大小不能超过20KB。
  • 您最多可以在一个并行文件系统下配置20条生命周期管理规则，超过20条将提示不支持。
  • 您必须是桶拥有者或拥有设置桶的生命周期配置的权限，才能设置桶的生命周配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutLifecycleConfiguration权限，如果使用桶策略则需授予PutLifecycleConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

func (obsClient ObsClient) SetBucketLifecycleConfiguration(input *SetBucketLifecycleConfigurationInput) (output *BaseModel, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*SetBucketLifecycleConfigurationInput

必选

参数解释：

设置桶的生命周期配置请求参数，详见SetBucketLifecycleConfigurationInput。
表2 SetBucketLifecycleConfigurationInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

LifecycleRules

[]LifecycleRule

必选

参数解释：

桶生命周期规则列表，详见LifecycleRule。
表3 LifecycleRule

参数名称

参数类型

是否必选

描述

ID

string

作为请求参数时可选

参数解释：

生命周期规则ID。

取值范围：

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

默认取值：

无

Prefix

string

作为请求参数时必选

参数解释：

对象名前缀，用以标识哪些对象可以匹配到当前这条规则。可为空字符串，代表匹配桶内所有对象。

例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将ExampleObject.jpg指定为前缀，则规则仅应用于该特定对象。如果您将logs/指定为前缀，规则将应用于密钥名称以字符串“logs/”开头的三个对象。如果您指定空的前缀，规则将应用于桶中的所有对象。

取值范围：

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

默认取值：

无

Status

RuleStatusType

作为请求参数时必选

参数解释：

标识当前规则是否启用。

取值范围：

规则启用状态取值详见RuleStatusType。

默认取值：

无

Transitions

[]Transition

作为请求参数时可选

参数解释：

对象转换策略列表，用于使用生命周期规则转换对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见Transition。

约束限制：

仅针对对象的最新版本。

Expiration

Expiration

作为请求参数时可选

参数解释：

对象过期时间配置，详见Expiration。

约束限制：

仅针对对象的最新版本。

NoncurrentVersionTransitions

[]NoncurrentVersionTransition

作为请求参数时可选

参数解释：

历史版本对象转换策略列表，用于使用生命周期规则转换历史版本对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见NoncurrentVersionTransition。

约束限制：

  • 仅针对对象的历史版本。
  • 当前桶已启用（或开启后暂停）多版本。

NoncurrentVersionExpiration

NoncurrentVersionExpiration

作为请求参数时可选

参数解释：

历史版本对象过期时间配置，详见NoncurrentVersionExpiration。

约束限制：

  • 仅针对对象的历史版本。
  • 当前桶已启用（或开启后暂停）多版本。
注意：

并行文件系统不支持该参数。

Transitions、Expiration、NoncurrentVersionTransitions、NoncurrentVersionExpiration不能全为空。

表4 RuleStatusType

常量名

原始值

说明

RuleStatusEnabled

Enabled

启用规则。

RuleStatusDisabled

Disabled

禁用规则。
表5 Transition

参数名称

参数类型

是否必选

描述

StorageClass

StorageClassType

作为请求参数时必选

参数解释：

对象转换后的存储类型。

约束限制：

  • 不支持“标准存储”类型。
  • 对象存储类别转换限制：
    • 仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。
    • 仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动先恢复对象，然后手动转换存储类别。
    • 归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档存储。

取值范围：

生命周期转换的目标存储类别取值范围详见StorageClassType。

默认取值：

无

Date

time.Time

作为请求参数时，如果没有设置Days则必选

参数解释：

指定OBS对该日期之前的对象执行生命周期规则。

约束限制：

日期格式必须为ISO8601的格式，并且为UTC的零点。 例如：2018-01-01T00:00:00.000Z，表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象转换成其他存储类型，等于或晚于这个时间的对象不会被转换成其他存储类型。

代码示例：time.Now().Add(time.Duration(24) * time.Hour)。

默认取值：

无

Days

int

作为请求参数时，如果没有设置Date则必选

参数解释：

指定生命周期规则在对象最后更新过后多少天生效。

约束限制：

仅适用于对象的最新版本。

取值范围：

0~（231-1），单位：天。

默认取值：

无
表6 StorageClassType

常量名

原始值

说明

StorageClassStandard

STANDARD

标准存储。

标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1MB），且需要频繁访问数据的业务场景。

StorageClassWarm

WARM

低频访问存储。

低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。

StorageClassCold

COLD

归档存储。

归档存储适用于很少访问（平均一年访问一次）数据的业务场景。
表7 Expiration

参数名称

参数类型

是否必选

描述

Date

time.Time

作为请求参数时，如果没有设置Days则必选

参数解释：

指定OBS对该日期之前的对象执行生命周期规则，即执行过期删除操作。

约束限制：

日期格式必须为ISO8601的格式，并且为UTC的零点。 例如：2018-01-01T00:00:00.000Z，表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象删除，等于或晚于这个时间的对象不会被删除。

代码示例：time.Now().Add(time.Duration(24) * time.Hour)。

默认取值：

无

Days

int

作为请求参数时，如果没有设置Date则必选

参数解释：

指定生命周期规则在对象最后更新过后多少天生效，即执行过期删除操作。

约束限制：

仅适用于对象的最新版本。

取值范围：

1~（231-1），单位：天

默认取值：

无
表8 NoncurrentVersionTransition

字段名

类型

约束

说明

StorageClass

StorageClassType

作为请求参数时必选

参数解释：

历史版本对象转换后的存储类型。

约束限制：

  • 不支持“标准存储”类型。
  • 对象存储类别转换限制：
    • 仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。
    • 仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动先恢复对象，然后手动转换存储类别。
    • 归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档存储。

取值范围：

生命周期转换的目标存储类别取值范围详见StorageClassType。

默认取值：

无

NoncurrentDays

int

作为请求参数时必选

参数解释：

表示对象在成为历史版本之后第几天时规则生效。

约束限制：

仅适用于历史版本。

取值范围：

0~（231-1），单位：天

默认取值：

无
表9 NoncurrentVersionExpiration

参数名称

参数类型

是否必选

描述

NoncurrentDays

int

作为请求参数时必选

参数解释：

表示对象在成为历史版本之后第几天时规则生效。

约束限制：

仅针对历史版本。

取值范围：

0~（231-1），单位：天

默认取值：

无

返回结果说明

表10 返回结果列表

参数名称

参数类型

描述

output

*BaseModel

参数解释：

接口返回信息，详见BaseModel。

err

error

参数解释：

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

参数名称

参数类型

描述

StatusCode

int

参数解释：

HTTP状态码。

取值范围：

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

默认取值：

无

RequestId

string

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

ResponseHeaders

map[string][]string

参数解释：

HTTP响应头信息。

默认取值：

无

代码示例

本示例用于设置名为examplebucket桶的生命周期规则

 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
46
47
48
49
50
51
52
53
 
package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com"
    // 创建obsClient实例
    // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
    obsClient, err := obs.New(ak, sk, endPoint, obs.WithSignature(obs.SignatureObs)/*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.SetBucketLifecycleConfigurationInput{}
    // 指定桶名称
    input.Bucket = "examplebucket"
    // 指定桶生命规则
    input.LifecycleRules = []obs.LifecycleRule{
        {
            ID:     "rule1",
            Prefix: "objectPrefix/",
            Status: obs.RuleStatusEnabled,
            Transitions: []obs.Transition{
                {Days: 30, StorageClass: obs.StorageClassCold},
            },
            Expiration:                  obs.Expiration{Days: 100},
            NoncurrentVersionExpiration: obs.NoncurrentVersionExpiration{NoncurrentDays: 20},
        },
    }
    // 设置桶的生命周期
    output, err := obsClient.SetBucketLifecycleConfiguration(input)
    if err == nil {
        fmt.Printf("Set bucket(%s)'s  LifecycleConfiguration successful!\n", input.Bucket)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        return
    }
    fmt.Printf("Set bucket(%s)'s  LifecycleConfiguration fail!\n", input.Bucket)
    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)
    }
}

相关链接

  • 关于设置桶的生命周期配置的API说明，请参见设置桶的生命周期配置。
  • 更多关于设置桶的生命周期配置的示例代码，请参见Github示例。
  • 设置桶的生命周期配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。