GET Bucket tagging

Last updated: 2021-08-30 14:39:10

    Overview

    This API is used to query the existing bucket tags of a bucket.

    Note:

    If a sub-account needs to call this API (GET Bucket tagging), ensure that the root account has authorized it to do so.

    API Explorer is recommended.
    Debug
    API Explorer makes it easy to make online API calls, verify signatures, generate SDK code, search for APIs, etc. You can also use it to query the content of each request as well as its response.

    Request

    Sample request

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

    Request headers

    This API only uses Common Request Headers.

    Request body

    The request body of this request is empty.

    Response

    Response headers

    This API only returns Common Response Headers.

    Response body

    If the request is successful, application/xml data that contains information about the bucket’s tags will be returned.

    <Tagging>
      <TagSet>
          <Tag>
              <Key>string</Key>
              <Value>string</Value>
          </Tag>
          <Tag>
              <Key>string</Key>
              <Value>string</Value>
          </Tag>
      </TagSet>
    </Tagging>
    

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type
    Tagging None Tagging configuration Container
    TagSet Tagging Tag set Container
    Tag Tagging.TagSet A single tag. Up to 50 tags are supported. Containers
    Key Tagging.TagSet.Tag Tag key, which can be up to 128 characters. A tag key can contain letters, digits, spaces, plus signs (+), minus signs (−), underscores (_), equals signs (=), dots (.), colons (:), and slashes (/). String
    Value Tagging.TagSet.Tag Tag value, which can be up to 256 characters. A tag value can contain letters, digits, spaces, plus signs (+), minus signs (−), underscores (_), equals signs (=), dots (.), colons (:), and slashes (/). String

    Error codes

    This API returns common error responses and error codes. For more information, please see Error Codes.

    Sample

    Request

    The following example queries the tags of the examplebucket-1250000000 bucket. COS parses the request and returns the {age:18} and {name:xiaoming} tags:

    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=AKIDrbAYjEBqqdEconpFi8NPFsOjrnX4****&q-sign-time=1516361923;1517361973&q-key-time=1516361923;1517361973&q-url-param-list=tagging&q-header-list=content-md5;host&q-signature=71251feb4501494edcfbd01747fa87300375****
    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>