GET Bucket tagging

Last updated: 2020-03-17 10:03:44

    Description

    COS supports getting tags for existing buckets. This API is used to get existing tags of a specified bucket.

    If you call the GET Bucket tagging API using a sub-account, please make sure that you have obtained the permission to use this API from the root account.

    Request

    Sample Request

    GET /?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

    The request body of this request is empty.

    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 elements of this response body are described in details below:

    Node Name (Keyword) Parent Node Description Type
    Tagging None Tag set Container
    TagSet Tagging Tag set Container
    Tag Tagging.TagSet Tag set, which can contain up to 10 tags Containers
    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
    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

    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
    NoSuchTagSetError No bucket tag has been set for the requested bucket 404 Not Found

    Example

    Request

    The following request is made to get the tags of the bucket examplebucket-1250000000. COS parses the request and returns the two existing tags of the bucket, {age:18} and {name:xiaoming}.

    GET /?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

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Connection: close
    Date: Fri, 19 Jan 2018 11:40:22 GMT
    Server: tencent-cos
    <Tagging>
        <TagSet>
            <Tag>
                <Key>age</Key>
                <Value>18</Value>
            </Tag>
            <Tag>
                <Key>name</Key>
                <Value>xiaoming</Value>
            </Tag>
        </TagSet>
    </Tagging>

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help