• Object Storage Service

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

GET Bucket tagging

API Description

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

Method Definition

ObsClient.getBucketTagging (parameter, callback)

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

TagSet

Object

Bucket tag set

  

Tag

Array

List of bucket tags

  

Key

String

Tag name that contains a maximum of 36 characters

Value

String

Tag value that contains a maximum of 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.TagSet.Tag.forEach(function(tag){
                           console.log('Tag-->' + tag.Key + ':' + tag.Value);
                     });
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});