Help Center/ Object Storage Service/ SDK Reference/ Java/ Versioning (SDK for Java)/ Configuring Versioning for a Bucket (SDK for Java)
Updated on 2024-06-18 GMT+08:00

Configuring Versioning for a Bucket (SDK for Java)

Function

OBS keeps multiple versions of an object in a versioning-enabled bucket. That way you can quickly retrieve and restore every object version as needed, or recover data from both accidental actions and application failures. For more information, see Versioning.

This API configures the versioning status for a bucket.

Restrictions

Method

obsClient.setBucketVersioning(final SetBucketVersioningRequest request)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

SetBucketVersioningRequest

Yes

Explanation:

Request parameters for bucket versioning configuration. For details, see Table 2.

Table 2 SetBucketVersioningRequest

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 periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Default value:

None

status

VersioningStatusEnum

Yes

Explanation:

Versioning status of the bucket.

Value range:

See Table 3.

Table 3 VersioningStatusEnum

Constant

Default Value

Description

SUSPENDED

Suspended

Versioning is suspended.

ENABLED

Enabled

Versioning is enabled.

Responses

Table 4 Common response headers

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

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

Code Examples

This example enables and suspends versioning of bucket examplebucket.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketVersioningConfiguration;
import com.obs.services.model.VersioningStatusEnum;
public class SetBucketVersioning001 {
    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 advised not 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. EU-Dublin is used here as an example. Replace it with the one in your actual situation.
        String endPoint = "https://obs.eu-west-101.myhuaweicloud.eu"; 
        // Obtain an endpoint using environment variables or import it in other ways.
        //String endPoint = System.getenv("ENDPOINT");
        
        // Create an ObsClient instance.
        // Use the permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // Use the temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // Enable versioning.
            obsClient.setBucketVersioning(
                    "examplebucket", new BucketVersioningConfiguration(VersioningStatusEnum.ENABLED));
            // Suspend versioning.
            obsClient.setBucketVersioning(
                    "examplebucket", new BucketVersioningConfiguration(VersioningStatusEnum.SUSPENDED));
            System.out.println("setBucketVersioning successfully");
        } catch (ObsException e) {
            System.out.println("setBucketVersioning 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("setBucketVersioning failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}