Overview

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

Setting Versioning

Feature description

This API (PUT Bucket versioning) is used to set the versioning configuration for a bucket.

Method prototype

CosResult BucketOp::PutBucketVersioning(const PutBucketVersioningReq& req, PutBucketVersioningResp* resp);

Sample request

qcloud_cos::CosConfig config("./config.json");
qcloud_cos::CosAPI cos(config);
std::string bucket_name = "examplebucket-1250000000";
qcloud_cos::PutBucketVersioningReq req(bucket_name);
qcloud_cos::PutBucketVersioningResp resp;

// Enable versioning
req.SetStatus(true);

qcloud_cos::CosResult result = cos.PutBucketVersioning(req, &resp);

if (result.IsSucc()) {
    // Request successful
} else {
    // Request failed. You can call the CosResult member functions to output the error information, such as requestID.
} 

Parameter description

PutBucketVersioningReq provides the following method to enable/suspend versioning:

void SetStatus(bool is_enable);

Querying Versioning

Feature description

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

Method prototype

CosResult CosAPI::GetBucketVersioning(const GetBucketVersioningReq& request, GetBucketVersioningResp* response);

Sample request

qcloud_cos::CosConfig config("./config.json");
qcloud_cos::CosAPI cos(config);
std::string bucket_name = "examplebucket-1250000000";
qcloud_cos::GetBucketVersioningReq req(bucket_name);
qcloud_cos::GetBucketVersioningResp resp;

qcloud_cos::CosResult result = cos.GetBucketVersioning(req, &resp);

if (result.IsSucc()) {
    // Request successful. You can obtain the versioning status via the resp method.
} else {
    // Request failed. You can call the CosResult member functions to output the error information, such as requestID.
} 

Parameter description

GetBucketVersioningResp provides the following method to obtain the status of versioning:

int GetStatus() const;