Help Center> Object Storage Service> .NET> Versioning Management> Setting Versioning Status for a Bucket
Updated on 2023-12-25 GMT+08:00

Setting Versioning Status for a Bucket

If you have any questions during the development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference.

You can call ObsClient.SetBucketVersioning to set the versioning status for a bucket. OBS supports two versioning statuses.

Versioning Status

Description

Value in OBS .NET SDK

Enabled

  1. OBS creates a unique version ID for each uploaded object. Namesake objects are not overwritten and are distinguished by their own version IDs.
  2. Objects can be downloaded by specifying the version ID. By default, the latest object is downloaded if no version ID is specified.
  3. Objects can be deleted by specifying the version ID. If an object is deleted with no version ID specified, the object will generate a delete marker with a unique version ID but is not physically deleted.
  4. Objects of the latest version in a bucket are returned by default after ObsClient.ListObjects is called. You can call ObsClient.ListVersions to list a bucket's objects with all version IDs.
  5. Except for delete markers, storage space occupied by objects with all version IDs is billed.

VersionStatusEnum.Enabled

Suspended

  1. Existing objects with version IDs are not affected.
  2. OBS creates version ID null to an uploaded object and the object will be overwritten after a namesake one is uploaded
  3. Objects can be downloaded by specifying the version ID. By default, the latest object is downloaded if no version ID is specified.
  4. Objects can be deleted by version ID. If an object is deleted with no version ID specified, the object is only attached with a deletion mark and version ID null. Objects with version ID null are physically deleted.
  5. Except for delete markers, storage space occupied by objects with all version IDs is billed.

VersionStatusEnum.Suspended

Sample code:

// Initialize configuration parameters.
ObsConfig config = new ObsConfig();
config.Endpoint = "https://your-endpoint";
// Hard-coded or plaintext AK/SK are risky. For security purposes, encrypt your AK/SK and store them in the configuration file or environment variables. In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, configure environment variables AccessKeyID and SecretAccessKey.
// 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.
string accessKey= Environment.GetEnvironmentVariable("AccessKeyID", EnvironmentVariableTarget.Machine);
string secretKey= Environment.GetEnvironmentVariable("SecretAccessKey", EnvironmentVariableTarget.Machine);
// Create an instance of ObsClient.
ObsClient client = new ObsClient(accessKey, secretKey, config);
// Set the versioning status.
try
{
    SetBucketVersioningRequest request = new SetBucketVersioningRequest();
    request.BucketName = "bucketname";
    request.Configuration = new VersioningConfiguration();
    //Enabling versioning.
    request.Configuration.Status = VersionStatusEnum.Enabled;
    SetBucketVersioningResponse response = client.SetBucketVersioning(request);
    Console.WriteLine("Set bucket version response: {0}", response.StatusCode);
}
catch (ObsException ex)
{
    Console.WriteLine("ErrorCode: {0}", ex.ErrorCode);
    Console.WriteLine("ErrorMessage: {0}", ex.ErrorMessage);
}