Overview

This document provides an overview of APIs and SDK code samples related to basic bucket operations.

Checking a Bucket and Its Permissions

Description

This API is used to verify whether a bucket exists and whether you have permission to access it.

• If the bucket exists and you have permission to read it, HTTP status code 200 will be returned.
• If you do not have permission to read the bucket, HTTP status code 403 will be returned.
• If the bucket does not exist, the HTTP status code 404 will be returned.

Sample code

Extracting bucket information:

cos.headBucket({
   Bucket: 'examplebucket-1250000000', /* Required */
   Region: 'COS_REGION',     /* Bucket region. Required */
}, function(err, data) {
   console.log(err || data);
});

Determining whether the bucket exists:

function doesBucketExist() {
   cos.headBucket({
       Bucket: 'examplebucket-1250000000', /* Required */
       Region: 'COS_REGION',     /* Bucket region. Required */
   }, function(err, data) {
       if (data) {
           console.log('The bucket exists.');
       } else if (err.code === 404) {
           console.log('The bucket does not exist.');
       } else if (err.code === 403) {
           console.log('no permission to read the bucket');
       }
   });
}

Parameter description

Callback function description

function(err, data) { ... }

Deleting a Bucket

Description

This API is used to delete an empty bucket under a specified account. Note that if the deletion is successful, the HTTP status code 200 or 204 will be returned.

Note：

Before deleting a bucket, please make sure that all the data and incomplete multipart uploads in the bucket have been cleared; otherwise, the bucket cannot be deleted.

Sample code

cos.deleteBucket({
   Bucket: 'examplebucket-1250000000', /* Required */
   Region: 'COS_REGION',     /* Bucket region. Required */
}, function(err, data) {
   console.log(err || data);
});

Parameter description

Callback function description

function(err, data) { ... }