Obtain Bucket Metadata

Updated on 2022-02-10 GMT+08:00

View PDF

API Description

You can use this API to send a HEAD request to obtain the bucket metadata.

Method Definition

ObsClient.getBucketMetadata

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.

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.

Returned Result (InterfaceResult)

Field	Type	Description
RequestId	String	Request ID returned by the OBS server
StorageClass	String	Storage class of the bucket. When the storage class is OBS Standard, the value is null.
Location	String	Bucket location
ObsVersion	String	OBS server version

Sample Code

obsClient.getBucketMetadata({
       Bucket : 'bucketname'
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     console.log('StorageClass-->' + result.InterfaceResult.StorageClass);
                     console.log('Location-->' + result.InterfaceResult.Location);
              }else{
                     console.log('Status-->' + result.CommonMsg.Status);
              }
       }
});

Parent topic: Bucket-Related APIs

Previous topic: List Multipart uploads

Next topic: GET Bucket location