• Object Storage Service

obs
  1. Help Center
  2. Object Storage Service
  3. API Reference (Node.js SDK)
  4. Bucket-Related APIs
  5. GET Bucket storageinfo

GET Bucket storageinfo

API Description

You can use this API to obtain storage information about a bucket, including the bucket size and number of objects in the bucket.

Method Definition

ObsClient.getBucketStorageInfo(parameter, callback)

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

Returned Result

Field

Type

Description

RequestId

String

Request ID returned by the OBS server

Size

String

Bucket size

ObjectNumber

String

Number of objects in the bucket

Sample Code

obsClient.getBucketStorageInfo({
       Bucket : 'bucketname'
},(err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     console.log('Size-->' + result.InterfaceResult.Size);
                     console.log('ObjectNumber-->' + result.InterfaceResult.ObjectNumber);
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});