PUT Bucket versioning

Updated on 2023-03-16 GMT+08:00

View PDF

API Description

You can use this API to set the versioning status for a bucket.

Method Definition

ObsClient.setBucketVersioning

Request Parameter

Field	Type	Optional or Mandatory	Description
Bucket	String	Mandatory	Bucket name
RequestDate	String or Date	Optional	Request time NOTE: When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards.
VersionStatus	String	Mandatory	Versioning status of the bucket. Possible values are: Enabled Suspended

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

RequestDate

String

Date

Optional

Request time

NOTE:

When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards.

VersionStatus

String

Mandatory

Versioning status of the bucket. Possible values are:

Enabled
Suspended

Returned Result (InterfaceResult)

Field	Type	Description
RequestId	String	Request ID returned by the OBS server

Sample Code

obsClient.setBucketVersioning({
       Bucket : 'bucketname',
       VersionStatus : 'Enabled'
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});