PUT Bucket tagging

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

View PDF

API Description

You can use this API to set bucket tags.

Method Definition

1. ObsClient->setBucketTagging(array $parameter)
2. ObsClient->setBucketTaggingAsync(array $parameter, callable $callback)

Request Parameter

Field		Type	Optional or Mandatory	Description
Bucket		string	Mandatory	Bucket name
Tags		indexed array	Mandatory	Bucket tag set
	Key	string	Mandatory	Tag name, which contains 1 to 36 characters and cannot include non-printable ASCII characters (0–31) and the following special characters: *<>\= The tag keys in one bucket must be unique.
	Value	string	Mandatory	Tag value, which can contain up to 43 characters and cannot include non-printable ASCII characters (0–31) and the following special characters: *<>\=

Returned Result

Field	Type	Description
HttpStatusCode	integer	HTTP status code
Reason	string	Reason description
RequestId	string	Request ID returned by the OBS server

Sample Code

try{
       $resp = $obsClient -> setBucketTagging([
              'Bucket' => 'bucketname',
              'Tags' => [
                     ['Key' => 'tag1', 'Value' => 'value1'],
                     ['Key' => 'tag2', 'Value' => 'value2']
              ]
       ]);
       printf("RequestId:%s\n", $resp['RequestId']);
}catch (Obs\Common\ObsException $obsException){
       printf("ExceptionCode:%s\n", $obsException->getExceptionCode());
       printf("ExceptionMessage:%s\n", $obsException->getExceptionMessage());
}

Parent topic: Bucket-Related APIs

Previous topic: DELETE Bucket cors

Next topic: GET Bucket tagging