Help & DocumentationCloud Object StorageAPI DocumentationBucket APIsTag (tagging)PUT Bucket tagging

PUT Bucket tagging

Last updated: 2019-12-16 17:34:19

PDF

Contents：

Description

COS supports setting tags for existing buckets. This API is used to set key-value pairs for a bucket as tags, helping you manage existing bucket resources and costs.

Currently, up to 30 different tags can be set for one bucket.

Request

Sample Request

PUT /?tagging HTTP 1.1
Host:<BucketName-APPID>.cos.<Region>.myqcloud.com
Date:date
Authorization: Auth String

Authorization: Auth String (see Request Signature for more information).

Request Headers

Common Headers

The implementation of this operation uses common request headers. For more information on common request headers, see Common Request Headers.

Special Headers

This request operation does not use any special request header.

Request Body

For this request, you need to configure the following set of tags:

<?xml version="1.0" encoding="UTF-8" ?>
<Tagging>
    <TagSet>
        <Tag>
            <Key>age</Key>
            <Value>18</Value>
        </Tag>
        <Tag>
            <Key>name</Key>
            <Value>xiaoming</Value>
        </Tag>
    </TagSet>
</Tagging>

The data are described in details below:

Node Name (Keyword) Parent Node Description Type Required
Tagging None Tag set Container Yes
TagSet Tagging Tag set Container Yes
Tag Tagging.TagSet Tag set, which can contain up to 10 tags Containers Yes
Key Tagging.TagSet.Tag Tag key, which can contain up to 128 characters. A tag key can contain English letters, digits, spaces, plus signs, minus signs, underscores, equals signs, dots, colons, and slashes String Yes
Value Tagging.TagSet.Tag Tag value, which can contain up to 256 characters. A tag value can contain English letters, digits, spaces, plus signs, minus signs, underscores, equals signs, dots, colons, and slashes String Yes

Response

Response Headers

Common Response Headers

This response uses common response headers. For more information on common response headers, see Common Response Headers.

Special Response Headers

This request operation does not use any special response header.

Response Body

The response body of this request is empty.

Error Codes

The following describes some frequent special errors that may occur when you make this request:

Error Code Description HTTP Status Code
SignatureDoesNotMatch If the provided signature does not conform to the rule, this error code will be returned 403 Forbidden
NoSuchBucket If the bucket to which you want to add the rule does not exist, this error code will be returned 404 Not Found
MalformedXML Invalid XML format. Please check against the RESTful API documentation 400 Bad Request
BadRequest The maximum number of tags allowed for one bucket is exceeded. Currently, up to 10 tags can be set 400 Bad Request
InvalidTag Tag key or value contains the reserved string "cos:" or "Project" 400 Bad Request

Example

Request

The following request writes two tags "{age:18}" and "{name:xiaoming}" to the bucket examplebucket-1250000000. COS successfully configured the tags and returns 204 (success).

PUT /?tagging HTTP/1.1
User-Agent: curl/7.29.0
Accept: */*
Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.com
Authorization: q-sign-algorithm=sha1&q-ak=AKIDrbAYjEBqqdEconpFi8NPFsOjrnX4LYUE&q-sign-time=1516361923;1517361973&q-key-time=1516361923;1517361973&q-url-param-list=tagging&q-header-list=content-md5;host&q-signature=71251feb4501494edcfbd01747fa873003759404
Content-Md5: LIbd5t5HLPhuNWYkP6qHcQ==
Content-Length: 127
Content-Type: application/xml

<Tagging>
    <TagSet>
        <Tag>
            <Key>age</Key>
            <Value>18</Value>
        </Tag>
        <Tag>
            <Key>name</Key>
            <Value>xiaoming</Value>
        </Tag>
    </TagSet>
</Tagging>

Response

HTTP/1.1 204 No Content
Content-Type: application/xml
Content-Length: 0
Connection: keep-alive
Date: Fri, 19 Jan 2018 11:40:22 GMT
Server: tencent-cos
x-cos-request-id: NWE2MWQ5MjZfMTBhYzM1MGFfMTA5ODVfMTVjNDM=