Overview

This document provides an overview of APIs and SDK code samples related to versioning.

SDK API Reference

For the parameters and method descriptions of all the APIs in the SDK, see Api Documentation.

Setting Versioning

API description

This API is used to set a versioning configuration for a specified bucket. Once enabled, versioning can only be suspended but not disabled.

Sample code

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
PutBucketVersioningRequest request = new PutBucketVersioningRequest(bucket);
request.IsEnableVersionConfig(true); //true: enables versioning; false: suspends versioning

try
{
  PutBucketVersioningResult result = cosXml.PutBucketVersioning(request);
  Console.WriteLine(result.GetResultInfo());
}
catch (COSXML.CosException.CosClientException clientEx)
{
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For the complete sample, go to GitHub.

Querying Versioning

API description

This API is used to query the versioning configuration of a specified bucket.

• To get the versioning status of a bucket, you need to have read permission for the bucket.
• There are three versioning statuses: not enabled, enabled, and suspended.

Sample code

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketVersioningRequest request = new GetBucketVersioningRequest(bucket);

try
{
  GetBucketVersioningResult result = cosXml.GetBucketVersioning(request);
  // Bucket lifecycle configuration
  VersioningConfiguration conf =  result.versioningConfiguration;
}
catch (COSXML.CosException.CosClientException clientEx)
{
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For the complete sample, go to GitHub.