租户端 存储 对象存储（COS） COS API参考 查询存储桶标签

查询存储桶标签

最近更新时间: 2024-10-17 17:10:00

功能描述

COS 支持为已存在的 Bucket 查询标签（Tag）。GET Bucket tagging 接口用于查询指定存储桶下已有的存储桶标签。

说明：

若您使用子账号调用此项接口，请确保您已经在主账号处获取了 GET Bucket tagging 这个接口的权限。

请求

请求示例

GET /?tagging HTTP 1.1
Host:<BucketName-APPID>.<Endpoint>
Date: GMT Date
Authorization: Auth String

说明：

Authorization: Auth String（详情请参见请求签名文档）。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求的请求体为空。

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

查询成功，返回 application/xml 数据，包含存储桶下已有的标签信息。

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

具体的节点描述如下：

节点名称（关键字） 父节点 描述 类型
Tagging 无 标签集合 Container
TagSet Tagging 标签集合 Container
Tag Tagging.TagSet 标签集合, 最多支持50个标签 Containers
Key Tagging.TagSet.Tag 标签键, 长度不超过128字节，支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 String
Value Tagging.TagSet.Tag 标签值, 长度不超过256字节，支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 String

错误码

以下描述此请求可能会发生的一些特殊的且常见的错误情况：

错误码 描述 HTTP 状态码
SignatureDoesNotMatch 提供的签名不符合规则，返回该错误码 403 Forbidden
NoSuchBucket 如果试图添加的规则所在的 Bucket 不存在，返回该错误码 404 Not Found
NoSuchTagSetError 请求的存储桶中未设置存储桶标签 404 Not Found

实际案例

请求

如下请求申请查询存储桶examplebucket-1250000000下的标签信息，COS 解析该请求后，并返回了该存储桶下已有的 {age:18} 和 {name:xiaoming} 两个标签。

GET /?tagging HTTP/1.1
User-Agent: curl/7.29.0
Accept: */*
Host: examplebucket-1250000000.<Endpoint>
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-Length: 127
Content-Type: application/xml

响应

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>