文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 对象相关接口(Python SDK)/ 对象标签(Python SDK)/ 设置对象标签(Python SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

设置对象标签(Python SDK)

功能说明

用户可以通过本接口设置或更新对象（Object）的标签信息。对象标签使用一组键值对（Key-Value）标记对象。

如果请求中不携带版本号（versionId），需要确保执行者有PutObjectTagging权限。如果请求中携带版本号（versionId），需要确保执行者有PutObjectTagging+PutObjectVersionTagging权限。缺省情况下只有对象的所有者可以执行此操作，也可以通过设置桶策略或用户策略给其他用户。

默认设置Object当前版本的标签信息。可以通过指定versionId参数来设置指定Object版本的标签信息。如果对应版本为删除标记（Delete Marker），则OBS将返回404 Not Found。

接口约束

  • 您必须是桶拥有者或拥有设置对象标签的权限，才能设置对象标签。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObjectTagging(未开启多版本)、obs:object:PutObjectVersionTagging（开启或暂停多版本）权限，如果使用桶策略则需授予obs:object:PutObjectTagging(未开启多版本)、obs:object:PutObjectVersionTagging（开启或暂停多版本）权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
  • 文件桶不支持该功能
  • 每个对象最多能设置10个标签。

方法定义

ObsClient.setObjectTagging(bucketName, objectKey, tags, versionId, extensionHeaders)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

objectKey

str

必选

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

tags

list of dict

可选

参数解释：

标签列表。示例：[{'key': 'env', 'value': 'prod'}, {'key': 'project', 'value': 'demo'}]。

约束限制：

  • 标签的键值约束：

    键名（Key）区分大小写且必须唯一，不能为空且不能超过128个字符，不允许使用,/|<>=*\字符。

    键值（Value）区分大小写且可以为空，不能超过255个字符，不允许使用,/|<>=*\字符。

默认取值：

无

versionId

str

可选

参数解释：

对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。

取值范围：

长度为32的字符串。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无

返回结果

表2 返回结果

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表3 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

代码样例

本示例用于设置examplebucket桶内的exampleobject对象的标签。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
# 运行本代码示例之前，请确保已设置环境变量AccessKeyID和SecretAccessKey
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucket_name = 'examplebucket'
    object_name = 'exampleobject'
    # 对象标签列表
    tags = [
        {'key': 'project', 'value': 'demo'},
        {'key': 'env', 'value': 'production'},
        {'key': 'owner', 'value': 'test-team'}
    ]
    # 设置对象标签
    resp = obsClient.setObjectTagging(bucket_name, object_name, tags)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Set Object Tagging Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Object Tagging Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except Exception:
    print('Set Object Tagging Failed')
    print(traceback.format_exc())

相关文档