tencent cloud

All product documents
APIs
DocumentationAPIsCloud Object StorageObject APIsObject TagGET Object tagging
GET Object tagging
Last updated: 2024-06-12 15:10:38
GET Object tagging
Last updated: 2024-06-12 15:10:38

Overview

This API is used to query the existing tags of an object.
If a sub-account needs to call this API (GET Object tagging), ensure that the root account has authorized it to do so.

Versioning

If you have enabled versioning for the bucket and want to query the tags of an object of a specified version, include the VersionId parameter in the request.

Request

Sample request

GET /<ObjectKey>?tagging&VersionId=VersionId HTTP 1.1
Host:<BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Note:
Host:<BucketName-APPID>.cos.<Region>.myqcloud.com, where <BucketName-APPID> is the is the bucket name followed by the APPID, such as examplebucket-1250000000 (see Bucket Overview > Basic Information and Bucket Overview > Bucket Naming Conventions), and <Region> is a COS region (see Regions and Access Endpoints).
Authorization: Auth String (See Request Signature for details.)

Request parameters

Parameter
Description
Type
Required
versionId
Version ID of the object (if versioning is enabled). If this parameter is not specified, the latest version will be queried.
string
No

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

The following describes the nodes of the response body returned for this request:
Node Name (Keyword)
Parent Node
Description
Type
Required
Tagging
None
Tagging configuration
Container
Yes
TagSet
Tagging
Tag set
Container
Yes
Tag
Tagging.TagSet
A single tag. Up to 10 tags are supported.
Containers
Yes
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
Yes
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
Yes

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 exampleobject.txt object in the examplebucket-1250000000 bucket. COS parses the request and returns the {age:18} and {name:xiaoming} tags.
GET /exampleobject.txt?tagging HTTP/1.1
User-Agent: curl/7.29.0
Accept: */*
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Authorization: Auth String
Content-Md5: MD5 String
Content-Length: 127
Content-Type: application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Connection: close
Date: Fri, 19 Jan 2020 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?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon