GET Bucket tagging

Updated on 2023-03-16 GMT+08:00

View PDF

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
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
Tags		Array	Bucket tag set
	Key	String	Tag name, which can contain up to 36 characters
	Value	String	Tag value, which can contain up to 43 characters

Sample Code

obsClient.getBucketTagging({
       Bucket : 'bucketname'
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     for(var i=0;i<result.InterfaceResult.Tags.length;i++){
                           var tag = result.InterfaceResult.Tags[i];
                           console.log('Tag-->' + tag.Key + ':' + tag.Value);                  
                     }
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});