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

Configuring WORM Retention for an Object (SDK for Java)

Function

This API is used to configure or update the retention period for objects uploaded to a bucket with WORM enabled.

  • If you did not configure a retention period or apply the default bucket-level protection rule when uploading an object, you can perform this operation to configure a retention period for the object.
  • If you already configured a retention period or applied the default bucket-level protection rule when uploading an object, you can perform this operation to prolong the retention period for the object.
  • The retention period of an object can only be modified, but not deleted.

Restrictions

Method

obsClient.setObjectRetention(SetObjectRetentionRequest request)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

Table 2

Yes

Explanation:

Request parameters for configuring a WORM policy for an object. For details, see Table 2.

Table 2 SetObjectRetentionRequest

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

objectKey

String

Yes

Explanation:

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object that does not contain the bucket name.

For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt.

Value range:

The value must contain 1 to 1,024 characters.

Default value:

None

retention

Table 3

Yes

Explanation:

Object-level WORM retention policy. For details, see Table 3.

versionId

String

No

Explanation:

Object version ID, for example, G001117FCE89978B0000401205D5DC9.

Value range:

The value must contain 32 characters.

Default value:

None. If this parameter is not specified, the latest version of the object is specified by default.

Table 3 ObjectRetention

Parameter

Type

Mandatory (Yes/No)

Description

mode

String

Yes

Explanation:

WORM retention policy of an object.

Restrictions:

N/A

Value range:

COMPLIANCE: compliance mode

Default value:

None

retainUntilDate

String

Yes

Explanation:

Retention period of an object, for example, 1435728035000.

Restrictions:

  • Its value is a timestamp accurate to milliseconds, for example, 1435728035000 (corresponding to 13:20:35 on July 1, 2015).
  • The retention period can only be prolonged but cannot be shortened.

Value range:

The value must be later than the current time.

Default value:

None

Responses

Table 4 HeaderResponse

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:

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

Sample Code

This example configures a WORM policy for object exampleObject in bucket exampleBucket.
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.objectlock.ObjectRetention;
import com.obs.services.model.objectlock.SetObjectRetentionRequest;
public class SetObjectRetention {
    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";
            String exampleObject = "exampleObject";
            long retainUntilDate = System.currentTimeMillis() + 30L * 24 * 60 * 60 * 1000;
            ObjectRetention retention = new ObjectRetention("COMPLIANCE", retainUntilDate);
            SetObjectRetentionRequest request = new SetObjectRetentionRequest(exampleBucket, exampleObject, retention);
            obsClient.setObjectRetention(request);
            System.out.println("SetObjectRetention successfully");
        } catch (ObsException e) {
            System.out.println("SetObjectRetention 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("SetObjectRetention failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}