Updated on 2026-08-14 GMT+08:00

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

Method

func (obsClient ObsClient) GetBucketWormConfiguration(BucketName *string) (output *GetBucketWormConfigurationOutput, err error)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

BucketName

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 with the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request.

Default value:

None

Responses

Table 2 List of returned results

Parameter

Type

Description

output

*GetBucketWormConfigurationOutput

Explanation:

Returned results. For details, see Table 3.

err

error

Explanation:

The error message returned by the server.

Table 3 GetBucketWormConfigurationOutput

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

Table 4 Rule

Parameter

Type

Mandatory (Yes/No)

Description

DefaultRetention

*DefaultRetention

Yes

Explanation:

Bucket-level WORM policy.

Restrictions:

N/A

Value range:

For details, see Table 5.

Default value:

N/A

Table 5 DefaultRetention

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:

  • One year is considered as 365 days, regardless of the leap year.
  • 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~100

Default value:

N/A

Sample Code

This example obtains the default WORM policy of 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/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)
    }
}