Obtaining the Lifecycle Configuration of 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 returns the lifecycle rules of a bucket.
Restrictions
- To obtain the lifecycle configuration of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetLifecycleConfiguration in IAM or GetLifecycleConfiguration in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
Method
func (obsClient ObsClient) GetBucketLifecycleConfiguration(bucketName string) (output *GetBucketLifecycleConfigurationOutput, err error)
Request Parameters
Parameter |
Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|
bucketName |
string |
Yes |
Explanation: Bucket name Restrictions:
Default value: None |
Responses
Parameter |
Type |
Description |
---|---|---|
output |
Explanation: Returned results. For details, see Table 3. |
|
err |
error |
Explanation: Error messages returned by the API |
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 |
LifecycleRules |
Explanation: Lifecycle rule information. For details, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
ID |
string |
Explanation: Lifecycle rule ID Value range: The value must contain 1 to 255 characters. Default value: None |
Prefix |
string |
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 |
Explanation: Whether the rule is enabled Value range: See Table 5. Default value: None |
|
Transitions |
Explanation: Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 6. Restrictions: This parameter applies only to the current object version. |
|
Expiration |
Explanation: Object expiration time. For details, see Table 8. Restrictions: This parameter applies only to the current object version. |
|
NoncurrentVersionTransitions |
Explanation: Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 9. Restrictions:
|
|
NoncurrentVersionExpiration |
Explanation: Expiration time of noncurrent object versions. For details, see Table 10. Restrictions:
CAUTION:
This parameter is not available for parallel file systems. |
![](https://support.huaweicloud.com/intl/en-us/sdk-go-devg-obs/public_sys-resources/note_3.0-en-us.png)
Transitions, Expiration, NoncurrentVersionTransitions, and NoncurrentVersionExpiration cannot be all left blank.
Constant |
Default Value |
Description |
---|---|---|
RuleStatusEnabled |
Enabled |
Enabled |
RuleStatusDisabled |
Disabled |
Disabled |
Parameter |
Type |
Description |
---|---|---|
StorageClass |
Explanation: Storage class of the object after transition Restrictions:
Value range: See Table 7. Default value: None |
|
Date |
time.Time |
Explanation: Date when an object will be transitioned Restrictions: The value must conform with the ISO8601 standards and must be at 00:00 (UTC time). For example, 2018-01-01T00:00:00Z, 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 |
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: 0 to (231 – 1), in days Default value: None |
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. |
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:00Z, 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 (231 – 1), in days Default value: None |
Parameter |
Type |
Description |
---|---|---|
StorageClass |
Explanation: Storage class of noncurrent object versions after transition Restrictions:
Value range: See Table 7. Default value: None |
|
NoncurrentDays |
int |
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 (231 – 1), in days Default value: None |
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 (231 – 1), in days Default value: None |
Code Examples
This example returns the lifecycle configuration of bucket 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 |
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/intl/en-us/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. CN-Hong Kong is used here as an example. Replace it with the one currently in use. endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com" // 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.WithSecurityToken(securityToken)*/) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } // Specify a bucket name. bucketname := "examplebucket" // Obtain the lifecycle configuration of the bucket. output, err := obsClient.GetBucketLifecycleConfiguration(bucketname) if err == nil { fmt.Printf("Get LifecycleConfiguration successful with bucket:%s!\n", bucketname) fmt.Printf("RequestId:%s\n", output.RequestId) return } fmt.Printf("Get LifecycleConfiguration fail with bucket:%s!\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) } } |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot