All Products
Search
Document Center

Object Storage Service:PutBucketTags

Last Updated:Apr 28, 2024

Adds tags to a bucket or modifies the tags of a bucket.

Usage notes

When you call the PutBucketTags operation, take note of the following items:

  • Only the owner of a bucket and authorized RAM users can configure tags for the bucket. If other users attempt to configure tags for the bucket, 403 Forbidden is returned with the error code AccessDenied.

  • You can configure up to 20 tags for a bucket. A tag is a key-value pair.

  • When you call PutBucketTags to add a tag to a bucket, the new tag overwrites the existing tag that has the same key.

Request syntax

PUT /?tagging HTTP/1.1
Date: GMT Date
Content-Length: ContentLength
Authorization: SignatureValue
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
  <TagSet>
    <Tag>
      <Key>key1</Key>
      <Value>value1</Value>
    </Tag>
    <Tag>
      <Key>key2</Key>
      <Value>value2</Value>
    </Tag>
  </TagSet>
</Tagging>

Request headers

A PutBucketTags request contains only common request headers. For more information, see Common request headers.

Request elements

Element

Type

Required

Description

Tagging

Container

Yes

The container used to store TagSet.

Child nodes: TagSet

Parent nodes: none

TagSet

Container

Yes

The container used to store a set of Tags.

Child nodes: Tag

Parent nodes: Tagging

Tag

Container

Yes

The container used to store the tag that you want to add or modify.

Child nodes: Key and Value

Parent nodes: TagSet

Key

STRING

Yes

The key of a tag.

  • A tag key is up to 64 bytes in length.

  • A tag key cannot start with http://, https://, or Aliyun.

  • A tag key must be UTF-8 encoded.

  • The value of the element cannot be empty.

Child nodes: none

Parent nodes: Tag

Value

STRING

No

The value of a tag.

  • A tag value is up to 128 bytes in length.

  • A tag value must be UTF-8 encoded.

  • This parameter can be left empty.

Child nodes: none

Parent nodes: Tag

Response headers

The response to a PutBucketTags request contains only common response headers. For more information, see Common response headers.

Examples

  • Sample request

    PUT /?tagging
    Host: oss-example.oss-cn-hangzhou.aliyuncs.com
    Date: Tue, 20 Dec 2018 11:49:13 GMT
    Authorization: OSS qn6q**************:77Dv****************
    <Tagging>
      <TagSet>
        <Tag>
          <Key>testa</Key>
          <Value>testv1</Value>
        </Tag>
        <Tag>
          <Key>testb</Key>
          <Value>testv2</Value>
        </Tag>
      </TagSet>
    </Tagging>
  • Sample response

    200 (OK)
    content-length: 0
    server: AliyunOSS
    x-oss-request-id: 5C1B138A109F4E405B2D****
    date: Thu, 20 Dec 2018 11:59:06 GMT
    x-oss-server-time: 148
    connection: keep-alive

OSS SDKs

You can use Object Storage Service (OSS) SDKs for the following programming languages to call the PutBucketTags operation: