Help Center> Object Storage Service> SDK Reference> PHP> Versioning Management> Setting Versioning Status for a Bucket
View PDF

Setting Versioning Status for a Bucket

If you have any questions during 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

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 object of the latest version 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.

Suspended
  1. Noncurrent object versions 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 object of the latest version is downloaded if no version ID is specified.
  4. Objects can be deleted by specifying version IDs. If an object is deleted with no version ID specified, the object is only attached with a delete marker whose version ID is 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.

Sample code:

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during source code installation.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
// Create an instance of ObsClient.
$obsClient = new ObsClient ( [ 
       'key' => '*** Provide your Access Key ***',
       'secret' => '*** Provide your Secret Key ***',
       'endpoint' => 'https://your-endpoint'
] );

// Enable versioning.
$resp = $obsClient->setBucketVersioning([
       'Bucket' => 'bucketname',
       'Status' => 'Enabled'
]);

printf ("RequestId:%s\n", $resp ['RequestId']);

// Suspend versioning.
$resp = $obsClient->setBucketVersioningConfiguration([
              'Bucket' => 'bucketname',
              'Status' => 'Suspended'
]);

printf ("RequestId:%s\n", $resp ['RequestId']);

Use the Status parameter to specify the versioning status of a bucket.

Parent topic: Versioning Management