tencent cloud

文档反馈

存储桶标签

最后更新时间:2022-04-18 14:25:44

    简介

    本文档提供关于存储桶标签的 API 概览以及 SDK 示例代码。

    API 操作名 操作描述
    PUT Bucket tagging 设置存储桶标签 为已存在的存储桶设置标签
    GET Bucket tagging 查询存储桶标签 查询指定存储桶下已有的存储桶标签
    DELETE Bucket tagging 删除存储桶标签 删除指定的存储桶标签

    设置存储桶标签

    功能说明

    PUT Bucket tagging 用于为已存在的存储桶设置标签。

    方法原型

    put_bucket_tagging(Bucket, Tagging={}, **kwargs)
    

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import logging
    # 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    # 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
    secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
    region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
                             # COS支持的所有region列表参见https://intl.cloud.tencent.com/document/product/436/6224
    token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://intl.cloud.tencent.com/document/product/436/14048
    scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    response = client.put_bucket_tagging(
      Bucket='examplebucket-1250000000',
      Tagging={
          'TagSet': {
              'Tag': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ]
          }
      }
    )
    

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 设置标签的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String
    Tag 标签的集合 List
    Key 标签的 Key,长度不超过128字节, 支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 String
    Value 标签的 Value,长度不超过256字节, 支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 String

    返回结果说明

    该方法返回值为 None。

    查询存储桶标签

    功能说明

    GET Bucket tagging 用于查询指定存储桶下已有的存储桶标签。

    方法原型

    get_bucket_tagging(Bucket, **kwargs)
    

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import logging
    # 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    # 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
    secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
    region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
                             # COS支持的所有region列表参见https://intl.cloud.tencent.com/document/product/436/6224
    token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://intl.cloud.tencent.com/document/product/436/14048
    scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    response = client.get_bucket_tagging(
      Bucket='examplebucket-1250000000'
    )
    

    参数说明 |

    参数名称 参数描述 类型 是否必填
    Bucket 查询标签的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String

    返回结果说明

    Bucket 标签管理列表,类型为 dict。

    {
      'TagSet': {
          'Tag': [
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      }
    }
    
    参数名称 参数描述 类型
    Tag 标签的集合 List
    Key 标签的 Key,长度不超过128字节, 支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 String
    Value 标签的 Value,长度不超过256字节, 支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 String

    删除存储桶标签

    功能说明

    DELETE Bucket tagging 用于删除指定存储桶下已有的存储桶标签。

    方法原型

    delete_bucket_tagging(Bucket, **kwargs)
    

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import logging
    # 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    # 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
    secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
    region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
                             # COS支持的所有region列表参见https://intl.cloud.tencent.com/document/product/436/6224
    token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://intl.cloud.tencent.com/document/product/436/14048
    scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    response = client.delete_bucket_tagging(
      Bucket='examplebucket-1250000000'
    )
    

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 被删除标签的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String

    返回结果说明

    该方法返回值为 None。

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持