功能描述
GET Object tagging 接口用于查询指定对象下已有的对象标签。
如您使用子账号调用此项接口,请确保您已经在主账号处获取了GET Object tagging
这个接口的权限。
版本控制
如果您的存储桶开启了版本控制,并且需要查询指定版本的对象的标签,可以在发起请求时携带 VersionId 参数,此时将查询指定版本对象的标签信息。
请求
请求示例
GET /<ObjectKey>?tagging&VersionId=VersionId HTTP 1.1
Host:<BucketName-APPID>.<Endpoint>
Date: GMT Date
Authorization: Auth String
说明:
Authorization: Auth String(详情请参见请求签名文档)。
请求参数
名称 | 描述 | 类型 | 是否必选 |
versionId | 当启用版本控制时,指定要操作的对象版本 ID,如不指定则查询最新版本对象的对象标签 | string | 否 |
请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
请求体
该请求的请求体为空。
响应
响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
响应体
该请求返回的响应体节点描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tagging | 无 | 标签集合 | Container | 是 |
TagSet | Tagging | 标签集合 | Container | 是 |
Tag | Tagging.TagSet | 标签集合,最多支持 10 个标签 | Containers | 是 |
Key | Tagging.TagSet.Tag | 标签键,长度不超过 128 字节,支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 | String | 是 |
Value | Tagging.TagSet.Tag | 标签值,长度不超过 256 字节,支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 | String | 是 |
错误码
以下描述此请求可能会发生的一些特殊的且常见的错误情况:
错误码 | 描述 | HTTP 状态码 |
SignatureDoesNotMatch | 提供的签名不符合规则,返回该错误码 | 403 Forbidden |
NoSuchKey | 如果试图查询的规则所在的对象不存在,返回该错误码 | 404 Not Found |
实际案例
请求
如下请求申请查询存储桶examplebucket-1250000000
中的对象exampleobject.txt
下的标签信息,CSP 解析该请求后并返回该存储桶下已有的{age:18}
和{name:xiaoming}
两个标签。
GET /exampleobject.txt?tagging HTTP/1.1
User-Agent: curl/7.29.0
Accept: */*
Host: <BucketName-APPID>.<Endpoint>
Authorization: Auth String
Content-Md5: MD5 String
Content-Length: 127
Content-Type: application/xml
响应
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>