Help Center/ Object Storage Service/ SDK Reference/ Go/ Buckets (SDK for Go)/ Configuring Lifecycle Rules for a Bucket (SDK for Go)

Updated on 2024-09-05 GMT+08:00

View PDF

Configuring Lifecycle Rules for a Bucket (SDK for Go)

Function

You can configure lifecycle rules to periodically delete objects or transition objects between storage classes. For more information, see Lifecycle Management.

This API configures lifecycle rules for a bucket.

Expired objects will be permanently deleted and cannot be recovered.
Multi-AZ redundancy is not available for Archive storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Archive storage class based on a lifecycle rule.
The minimum storage duration is 30 days for Infrequent Access storage, and 90 days for Archive storage. After an object is transitioned to the Archive storage class, if it stays in this storage class for less than 90 days, you still need to pay for a full 90 days.

Restrictions

There is no limit on the number of lifecycle rules in a bucket, but the total size of XML descriptions about all lifecycle rules in a bucket cannot exceed 20 KB.
A maximum of 20 lifecycle rules can be configured for a parallel file system.
To configure a lifecycle rule for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutLifecycleConfiguration in IAM or PutLifecycleConfiguration in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.

Method

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

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
input	*SetBucketLifecycleConfigurationInput	Yes	Explanation: Input parameters for lifecycle configuration. For details, see Table 2.

**Table 2** SetBucketLifecycleConfigurationInput
Parameter	Type	Mandatory (Yes/No)	Description
Bucket	string	Yes	Explanation: Bucket name Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Default value: None
LifecycleRules	[]LifecycleRule	Yes	Explanation: Lifecycle rule information. For details, see Table 3.

**Table 3** LifecycleRule
Parameter	Type	Mandatory (Yes/No)	Description
ID	string	No if used as a request parameter	Explanation: Lifecycle rule ID Value range: The value must contain 1 to 255 characters. Default value: None
Prefix	string	Yes if used as a request parameter	Explanation: Object name prefix. It identifies the objects the rule applies to. You can leave this parameter blank to apply the rule to all objects in the bucket. Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you set Prefix to ExampleObject.jpg, the rule applies to object ExampleObject.jpg only. If you set Prefix to logs/, the rule applies to the three objects with name starting with logs/. If you leave Prefix blank, the rule applies to all objects in the bucket. Value range: The value must contain 1 to 1,024 characters. Default value: None
Status	RuleStatusType	Yes if used as a request parameter	Explanation: Whether the rule is enabled Value range: See Table 4. Default value: None
Transitions	[]Transition	No if used as a request parameter	Explanation: Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 5. Restrictions: This parameter applies only to the current object version.
Expiration	Expiration	No if used as a request parameter	Explanation: Object expiration time. For details, see Table 7. Restrictions: This parameter applies only to the current object version.
NoncurrentVersionTransitions	[]NoncurrentVersionTransition	No if used as a request parameter	Explanation: Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 8. Restrictions: This parameter applies only to noncurrent object versions. Versioning is enabled (or suspended after being enabled) for the bucket.
NoncurrentVersionExpiration	NoncurrentVersionExpiration	No if used as a request parameter	Explanation: Expiration time of noncurrent object versions. For details, see Table 9. Restrictions: This parameter applies only to noncurrent object versions. Versioning is enabled (or suspended after being enabled) for the bucket. CAUTION: This parameter is not available for parallel file systems.

Transitions, Expiration, NoncurrentVersionTransitions, and NoncurrentVersionExpiration cannot be all left blank.

**Table 4** RuleStatusType
Constant	Default Value	Description
RuleStatusEnabled	Enabled	Enabled
RuleStatusDisabled	Disabled	Disabled

**Table 5** Transition
Parameter	Type	Mandatory (Yes/No)	Description
StorageClass	StorageClassType	Yes if used as a request parameter	Explanation: Storage class of the object after transition Restrictions: The Standard storage class is not supported. Restrictions on storage class transitions: Only transitions from the Standard storage class to the Infrequent Access storage class are supported. To transition objects from Infrequent Access to Standard, you must manually do it. Only transitions from the Standard or Infrequent Access storage class to the Archive storage class are supported. To transition objects from Archive to Standard or Infrequent Access, you must restore the archived objects first and then manually transition their storage classes. Multi-AZ redundancy is not available for Archive storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Archive storage class based on a lifecycle rule. Value range: See Table 6. Default value: None
Date	time.Time	Yes if this parameter is used as a request parameter and Days is absent	Explanation: OBS executes the lifecycle rule for objects that were modified before the specified date. Restrictions: The value must conform with the ISO8601 standards and must be at 00:00 (UTC time). For example, 2018-01-01T00:00:00.000Z, indicating only objects that were last modified before that time are transitioned to the specified storage class. Sample code: *time.Now().Add(time.Duration(24) time.Hour) Default value**: None
Days	int	Yes if this parameter is used as a request parameter and Date is absent	Explanation: Number of days (since the last update made to the current object version) after which the lifecycle rule takes effect. Restrictions: This parameter applies only to the current object version. Value range: 0 to (2³¹ – 1), in days Default value: None

**Table 6** StorageClassType
Constant	Default Value	Description
StorageClassStandard	STANDARD	OBS Standard Features low access latency and high throughput and is used for storing massive, frequently accessed (multiple times a month) or small objects (< 1 MB) requiring quick response.
StorageClassWarm	WARM	OBS Infrequent Access Used for storing data that is semi-frequently accessed (fewer than 12 times a year) but is instantly available when needed.
StorageClassCold	COLD	OBS Archive Used for storing rarely accessed (once a year) data.

**Table 7** Expiration
Parameter	Type	Mandatory (Yes/No)	Description
Date	time.Time	Yes if this parameter is used as a request parameter and Days is absent	Explanation: OBS executes the lifecycle rule for objects that were modified before the specified date. Restrictions: The value must conform with the ISO8601 standards and must be at 00:00 (UTC time). For example, 2018-01-01T00:00:00.000Z, indicating only objects that were last modified before that time are deleted. Sample code: *time.Now().Add(time.Duration(24) time.Hour) Default value**: None
Days	int	Yes if this parameter is used as a request parameter and Date is absent	Explanation: Number of days (since the last update was made to the object) after which the lifecycle rule takes effect Restrictions: This parameter applies only to the current object version. Value range: 1 to (2³¹ – 1), in days Default value: None

**Table 8** NoncurrentVersionTransition
Parameter	Type	Mandatory (Yes/No)	Description
StorageClass	StorageClassType	Yes if used as a request parameter	Explanation: Storage class of noncurrent object versions after transition Restrictions: The Standard storage class is not supported. Restrictions on storage class transitions: Only transitions from the Standard storage class to the Infrequent Access storage class are supported. To transition objects from Infrequent Access to Standard, you must manually do it. Only transitions from the Standard or Infrequent Access storage class to the Archive storage class are supported. To transition objects from Archive to Standard or Infrequent Access, you must restore the archived objects first and then manually transition their storage classes. Multi-AZ redundancy is not available for Archive storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Archive storage class based on a lifecycle rule. Value range: See Table 6. Default value: None
NoncurrentDays	int	Yes if used as a request parameter	Explanation: Number of days after the object becomes a noncurrent version, when the specified rule takes effect Restrictions: This parameter applies only to noncurrent object versions. Value range: 0 to (2³¹ – 1), in days Default value: None

**Table 9** NoncurrentVersionExpiration
Parameter	Type	Mandatory (Yes/No)	Description
NoncurrentDays	int	Yes if used as a request parameter	Explanation: Number of days an object is noncurrent before the specified rule takes effect Restrictions: This parameter applies only to noncurrent object versions. Value range: 0 to (2³¹ – 1), in days Default value: None

Responses

**Table 10** List of returned results
Parameter	Type	Description
output	*BaseModel	Explanation: Returned results. For details, see Table 11.
err	error	Explanation: Error messages returned by the API

**Table 11** BaseModel
Parameter	Type	Description
StatusCode	int	Explanation: HTTP status code Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None
RequestId	string	Explanation: Request ID returned by the OBS server Default value: None
ResponseHeaders	map[string][]string	Explanation: HTTP response headers Default value: None

Code Examples

This example configures a lifecycle rule for bucket examplebucket.

    
     
       
       
         package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html.
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding to reduce leakage risks. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    // securityToken := os.Getenv("SecurityToken")
    // Enter the endpoint corresponding to the bucket. EU-Dublin is used here as an example. Replace it with the one currently in use.
    endPoint := "https://obs.eu-west-101.myhuaweicloud.eu" 
    // Create an obsClient instance.
    // If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance.
    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{}
    // Specify a bucket name.
    input.Bucket = "examplebucket"
    // Create a lifecycle rule for the bucket.
    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},
        },
    }
    // Configure a lifecycle rule for the bucket.
    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)
    }
}

        

      

    
   