Configuring a WORM Policy for a Bucket
Function
OBS provides WORM in compliance mode. After a WORM policy is configured for a bucket, if no protection policy or retention period is set for newly uploaded objects, the bucket-level WORM policy will be automatically applied to these objects. You can call this API to configure a default protection policy and retention period for a bucket.
With a bucket's default WORM policy, if you do not specify a protection policy or retention period when you upload an object to the bucket, the default policy will be automatically applied to the newly uploaded object. An object-level WORM policy requires configuring a specific date, which indicates that an object will be protected until that date. For a default bucket-level WORM policy, a retention period is required, and the protection for an object starts when the object is uploaded to the bucket.
Restrictions
- To call this API, you must be the bucket owner or have the permission (obs:bucket:PutBucketObjectLockConfiguration granted using IAM or PutBucketObjectLockConfiguration granted using a bucket policy) to set a bucket-level WORM retention 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) SetBucketWormConfiguration(input *SetBucketDirectColdAccessInput) (output *BaseModel, err error)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| input | Yes | Explanation: Request parameters for configuring a WORM policy for a bucket. For details, see Table 2. |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| Bucket | string | Yes | Explanation: Bucket name. Restrictions:
Default value: None |
| ObjectLockConfiguration | Yes | Explanation: Versioning status of the bucket. Value range: See Table 3. Default value: None |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| ObjectLockEnabled | string | No | Explanation: Bucket-level WORM status. Restrictions: N/A Value range: Enabled: Bucket-level WORM is enabled. Default value: N/A |
| Rule | *Rule | No | Explanation: Bucket-level WORM policy. Restrictions: This parameter is mandatory when ObjectLockEnabled is set to Enabled. If this parameter is not specified, the default bucket-level WORM policy will be cleared. Value range: For details, see Table 4. Default value: N/A |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| DefaultRetention | Yes | Explanation: Bucket-level WORM policy. Restrictions: N/A Value range: For details, see Table 5. Default value: N/A |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| Mode | string | Yes | Explanation: WORM retention policy of a bucket. Restrictions: N/A Value range: COMPLIANCE: compliance mode Default value: N/A |
| Days | int | No | Explanation: Retention period, in days. Restrictions: Only one of Days and Years can be set to a value other than 0. The value must be within the allowed range. Value range: 1~36500 Default value: N/A |
| Years | int | No | Explanation: Default retention period, in years. Restrictions:
Value range: 1~100 Default value: N/A |
Responses
| Parameter | Type | Description |
|---|---|---|
| output | Explanation: Returned results. For details, see Table 7. | |
| err | error | Explanation: The error message returned by the server. |
| Parameter | Type | Description |
|---|---|---|
| StatusCode | int | Explanation: HTTP status code Restrictions: None 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 Restrictions: None Value range: None Default value: None |
| ResponseHeaders | map[string][]string | Explanation: HTTP response headers Restrictions: None Value range: None Default value: None |
Sample Code
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 not advised to use hard coding, which may result in information leakage. 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())
}
input := &obs.SetBucketWormConfigurationInput{}
// Specify a bucket name.
input.Bucket = "examplebucket"
// Specify a WORM policy.
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
// Configure the default WORM policy for the bucket.
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)
}
} What is your overall rating for this page?
Thank 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