Help Center> OBS Node.js SDK> API Reference> Bucket-Related APIs> HEAD Bucket
View PDF

HEAD Bucket

API Description

You can use this API to check whether a bucket exists. If the returned HTTP response code is 200, the bucket exists. If the returned HTTP response code is 404, the bucket does not exist.

Method Definition

ObsClient.headBucket

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

Returned Result (InterfaceResult)

Field

Type

Description

RequestId

String

Request ID returned by the OBS server

Sample Code

obsClient.headBucket({
       Bucket : 'bucketname'
}, (err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('Bucket exists');
              }else if(result.CommonMsg.Status === 404){
                     console.log('Bucket does not exist');
              }
       }
});
Parent topic: Bucket-Related APIs