文档首页/ 对象存储服务 OBS/ API参考/ API/ 桶的高级配置/ 获取桶标签-GetBucketTagging
更新时间：2025-12-18 GMT+08:00
查看PDF
分享

获取桶标签-GetBucketTagging

功能介绍

OBS使用GET操作来获取指定桶的标签。

要正确执行此操作，需要确保执行者有GetBucketTagging权限。缺省情况下只有桶的所有者可以执行此操作，也可以通过设置桶策略或用户策略授权给其他用户。

授权信息

您必须是桶拥有者或拥有获取桶标签的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。

  • 如果使用IAM授权，那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种，并配置相应权限：
    • 如果使用角色与策略授权（旧版IAM，即IAM v3接口），需具备obs:bucket:GetBucketTagging权限，授权操作请参见创建IAM自定义策略。
    • 如果使用身份策略授权（新版IAM，即IAM v5接口），如下表所示，需具备obs:bucket:getBucketTagging权限，授权操作请参见创建IAM自定义身份策略。

      授权项

      Action

      访问级别

      Access Level

      资源类型（*为必须）

      Resource Type (*: required)

      条件键

      Condition Key

      别名

      Alias

      依赖的授权项

      Dependencies

      obs:bucket:getBucketTagging

      Read

      bucket *

      -

      -

      -
      • obs:EpochTime
      • obs:SourceIp
      • obs:TlsVersion
      • obs:CustomDomain
  • 如果使用桶策略进行授权，需具备obs:bucket:GetBucketTagging权限，具体操作请参见自定义创建桶策略。

请求消息样式

1
2
3
4
 
GET /?tagging HTTP/1.1 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Date: date
Authorization: authorization string

请求消息参数

该请求消息中不使用消息参数。

请求消息头

该请求使用公共消息头，具体参见表3。

请求消息元素

此请求消息中不使用消息元素。

响应消息样式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
 
HTTP/1.1 status_code
x-obs-request-id: request id
x-obs-id-2: id
Content-Type: application/xml 
Content-Length: length
Date: date
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<Tagging xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
    <TagSet> 
        <Tag> 
            <Key>key</Key> 
            <Value>value</Value> 
        </Tag> 
    </TagSet> 
</Tagging>

响应消息头

该请求的响应消息使用公共消息头，具体请参考表1。

响应消息元素

在此请求返回的响应消息体中包含的配置元素如下表1。

表1 桶的标签配置元素

消息头名称

参数类型

描述

Tagging

XML

参数解释：

TagSet和Tag的父元素。

约束限制：

不涉及

TagSet

XML

参数解释：

Tag的父元素。父元素：Tagging

约束限制：

每个桶最多能设置20个标签，即TagSet下最多有20个Tag节点。

Tag

XML

参数解释：

Tag的信息元素。父元素：TagSet

约束限制：

每个桶最多能设置20个标签，即TagSet下最多有20个Tag节点。

Key

String

参数解释：

标签的名字。父元素：Tag

约束限制：

  • 标签的键名（Key）的最大长度为36个字符。
  • 标签的键名（Key）和键值（Value）不能包含字符“,”、“*”、“|”、“/”、“<”、“>”、“=”、“\”以及ASCII码0x00--0x1F的控制字符，在发送到服务器之前，必须将键名（Key）和键值（Value）进行UrlEncode编码。

取值范围：

长度大于1小于36的字符串

默认取值：

无

Value

String

参数解释：

标签的值。父元素：Tag

约束限制：

  • 标签的键值（Value）的最大长度为43个字符。
  • 标签的键名（Key）和键值（Value）不能包含字符“,”、“*”、“|”、“/”、“<”、“>”、“=”、“\”以及ASCII码0x00--0x1F的控制字符，在发送到服务器之前，必须将键名（Key）和键值（Value）进行UrlEncode编码。

取值范围：

长度大于等于0小于43的字符串。

默认取值：

无

错误响应消息

除了公共的错误码外，此接口还会返回一些其他的错误码。下表中列出本接口的一些常见错误，以及可能原因。如表2。

表2 配置桶标签的错误码列表

错误码

描述

HTTP状态码

NoSuchTagSet

指定的桶没有设置标签

404 Not Found

请求示例

1
2
3
4
5
6
 
GET /?tagging HTTP/1.1   
User-Agent: curl/7.29.0   
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*   
Date: Wed, 27 Jun 2018 13:25:44 GMT  
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:H1INcyc5i0XlHqYTfuzkPxLZUPM=

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
 
HTTP/1.1 200 OK 
x-obs-request-id: 0002B7532E0000015BEB35330C5884X1 
x-obs-id-2: s12w20LYNQqSb7moq4ibgJwmQRSmVQV+rFBqplOGYkXUpXeS/nOmbkyD+E35K79j 
Content-Type: application/xml 
Date: Wed, 27 Jun 2018 13:25:44 GMT 
Content-Length: 441 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Tagging xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
  <TagSet>
    <Tag>
      <Key>TagName1</Key>
      <Value>TagSetValue1</Value>
    </Tag>
  </TagSet>
</Tagging>
父主题： 桶的高级配置

相关文档