Obtaining the WORM Policy of a Bucket
Function
If a default WORM policy is configured for a bucket, you can call this API to obtain the default WORM policy of the bucket.
If you have never configured the default bucket-level retention policy after enabling WORM for a bucket, you can still use this API to check whether WORM is enabled.
Restrictions
- To obtain the WORM policy of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketObjectLockConfiguration granted using IAM or GetBucketObjectLockConfiguration granted using 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) GetBucketWormConfiguration(BucketName *string) (output *GetBucketWormConfigurationOutput, 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: The error message returned by the server. |
| 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 |
| 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 |
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.GetBucketWormConfigurationInput{}
// Specify a bucket name.
input.Bucket = "examplebucket
// Obtain the default WORM policy of the bucket.
output, err := obsClient.GetBucketWormConfiguration(bucketName)
if err == nil {
fmt.Printf("Get bucket(%s)'s WORM configuration successful!\n", bucketName)
fmt.Printf("ObjectLockEnabled: %s\n", output.ObjectLockEnabled)
if output.Rule != nil && output.Rule.DefaultRetention != nil {
fmt.Printf("DefaultRetention Mode: %s\n", output.Rule.DefaultRetention.Mode)
fmt.Printf("DefaultRetention Days: %d\n", output.Rule.DefaultRetention.Days)
}
fmt.Printf("RequestId:%s\n", output.RequestId)
return
}
fmt.Printf("Get 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