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

Obtaining the Default WORM Policy of a Bucket (SDK for Java)

Function

This API is used to obtain the default WORM policy of a 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

  • The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

obsClient.getObjectLockConfiguration(GetObjectLockConfigurationRequest request)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

Table 2

Yes

Explanation:

Request parameters for obtaining the default WORM policy of a bucket. For details, see Table 2.

Table 2 GetObjectLockConfigurationRequest

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 3 GetBucketTrashResult

Parameter

Type

Description

statusCode

int

Explanation:

HTTP status code

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors).

For more information, see Status Code.

Default value:

None

responseHeaders

Map<String, Object>

Explanation:

HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header.

Default value:

None

objectLockConfiguration

Table 4

Explanation:

WORM policy configuration. For details, see Table 4.

Table 4 ObjectLockConfiguration

Parameter

Type

Description

objectLockEnabled

String

Explanation:

Bucket-level WORM status

Value range:

Enabled: Bucket-level WORM is enabled.

rule

Table 5

Explanation:

Rules of a bucket-level WORM policy. For details, see Table 5.

Table 5 ObjectLockRule

Parameter

Type

Description

defaultRetention

Table 6

Explanation:

Default bucket-level WORM policy. For details, see Table 6.

Table 6 DefaultRetention

Parameter

Type

Description

mode

String

Explanation:

WORM retention policy of a bucket

days

int

Explanation:

Retention period, in days

years

int

Explanation:

Default retention period, in years

Sample Code

This example obtains the default WORM policy of bucket exampleBucket.
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.objectlock.DefaultRetention;
import com.obs.services.model.objectlock.GetObjectLockConfigurationRequest;
import com.obs.services.model.objectlock.GetObjectLockConfigurationResult;
import com.obs.services.model.objectlock.ObjectLockConfiguration;
public class GetObjectLockConfiguration {
    public static void main(String[] args) {
        // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using 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.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN North-Beijing4 is used here as an example. Replace it with the one currently in use.
        // Obtain an endpoint using environment variables or import it in other ways.
        String endPoint = System.getenv("ENDPOINT");
        ObsConfiguration obsConfiguration = new ObsConfiguration();
        obsConfiguration.setEndPoint(endPoint);
        ObsClient obsClient = new ObsClient(ak, sk, securityToken, obsConfiguration);
        try {
            String exampleBucket = "exampleBucket";
            GetObjectLockConfigurationRequest request = new GetObjectLockConfigurationRequest(exampleBucket);
            GetObjectLockConfigurationResult result = obsClient.getObjectLockConfiguration(request);
            ObjectLockConfiguration config = result.getObjectLockConfiguration();
            System.out.println("GetObjectLockConfiguration successfully");
            System.out.println("ObjectLockEnabled: " + config.getObjectLockEnabled());
            if (config.getRule() != null) {
                DefaultRetention retention = config.getRule().getDefaultRetention();
                System.out.println("Mode: " + retention.getMode());
                System.out.println("Days: " + retention.getDays());
                System.out.println("Years: " + retention.getYears());
            }
        } catch (ObsException e) {
            System.out.println("GetObjectLockConfiguration failed");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("GetObjectLockConfiguration failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}