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

GET Bucket tagging

API Description

You can use this API to obtain the tags of a specified bucket.

Method Definition

ObsClient.getBucketTagging

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

Tags

Array

Bucket tag set
  

Key

String

Tag name, which contains 1 to 36 characters

Value

String

Tag value, which can contain up to 43 characters

Sample Code

obsClient.getBucketTagging({
       Bucket : 'bucketname'
},(err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     result.InterfaceResult.Tags.forEach(function(tag){
                           console.log('Tag-->' + tag.Key + ':' + tag.Value);
                     });
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});
Parent topic: Bucket-Related APIs