Python设置对象标签

更新时间:2025-03-07 06:14:39

OSS支持使用对象标签(Object Tagging)对存储空间(Bucket)中的文件(Object)进行分类,本文介绍如何使用Python SDK V2设置对象标签。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 要设置对象标签,您必须具有oss:PutObjectTagging权限。具体操作,请参见RAM用户授权自定义的权限策略

方法定义

put_object_tagging(request: PutObjectTaggingRequest, **kwargs) → PutObjectTaggingResult

请求参数列表

参数名

类型

说明

参数名

类型

说明

request

PutObjectTaggingRequest

设置请求参数,具体请参见PutObjectTaggingRequest

返回值列表

类型

说明

类型

说明

PutObjectTaggingResult

返回值,具体请参见PutObjectTaggingResult

关于设置对象标签方法的完整定义,请参见put_object_tagging

示例代码

您可以使用以下代码设置指定文件的标签信息。

import argparse
import alibabacloud_oss_v2 as oss

# 创建一个命令行参数解析器,并添加必要的参数
parser = argparse.ArgumentParser(description="put object tagging sample")
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--key', help='The name of the object.', required=True)
parser.add_argument('--tag_key', help='The name of the tag key.', required=True)
parser.add_argument('--tag_value', help='The name of the tag value.', required=True)

def main():
    # 解析命令行参数
    args = parser.parse_args()

    # 从环境变量中加载凭证信息
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的默认配置
    cfg = oss.config.load_default()
    # 设置凭证提供者
    cfg.credentials_provider = credentials_provider
    # 设置区域
    cfg.region = args.region
    # 如果指定了endpoint,则设置endpoint
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 创建OSS客户端
    client = oss.Client(cfg)

    # 构建标签对象
    # 如果需要设置多个标签,可以按照以下格式添加更多的oss.Tag对象
    # tags = [oss.Tag(key=args.tag_key, value=args.tag_value), oss.Tag(key=args.tag_key2, value=args.tag_value2)]

    tags = [oss.Tag(
        key=args.tag_key,
        value=args.tag_value,
    )]

    # 执行设置对象标签的请求
    result = client.put_object_tagging(oss.PutObjectTaggingRequest(
        bucket=args.bucket,
        key=args.key,
        tagging=oss.Tagging(
            tag_set=oss.TagSet(
                tags=tags,
            ),
        ),
    ))

    # 打印请求结果
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version id: {result.version_id},'
    )

if __name__ == "__main__":
    main()

相关文档

  • 本页导读 (1)
  • 注意事项
  • 方法定义
  • 示例代码
  • 相关文档