华为云对象存储OBS获取桶标签(Python SDK)_云淘科技

功能介绍

为桶添加标签后,该桶上所有请求产生的计费话单里都会带上这些标签,从而可以针对话单报表做分类筛选,进行更详细的成本分析。例如:某个应用程序在运行过程会往桶里上传数据,可以用应用名称作为标签,设置到被使用的桶上。在分析话单时,就可以通过应用名的标签来分析此应用的成本。

调用获取桶标签接口,您可获取指定桶的标签。

接口约束

您必须是桶拥有者或拥有获取桶标签的权限,才能获取桶标签。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketTagging权限,如果使用桶策略则需授予GetBucketTagging权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。

方法定义

ObsClient.getBucketTagging(bucketName)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释

桶名。

约束限制:

桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
桶命名规则如下:

3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
禁止使用IP地址。
禁止以“-”或“.”开头及结尾。
禁止两个“.”相邻(如:“my..bucket”)。
禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。

同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

默认取值:

返回结果说明

类型

说明

GetResult

参数解释:

SDK公共结果对象。

表1 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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值:

GetResult.body类型

说明

TagInfo

参数解释:

桶标签配置,详见TagInfo。

表2 TagInfo

参数名称

参数类型

是否必选

描述

tagSet

list of Tag

作为请求参数时必选

参数解释:

桶标签列表,详见Tag。

约束限制:

一个桶默认最大拥有10个标签。每个标签有且只有一对键值。
同一个桶标签的键不能重复,但是值可以重复,并且可以为空

默认取值:

表3 Tag

参数名称

参数类型

是否必选

描述

key

str

作为请求参数时必选

参数解释:

标签的键。

约束限制:

同一个桶标签的键不能重复。
可以自定义,也可以选择预先在标签管理服务(TMS)创建好的标签。
长度范围为1到36个字符。
不能以空格开头或结尾,不能包含非打印字ASCII(0-31)、“=”、“*”、“”、“\”。
区分大小写。

默认取值:

value

str

作为请求参数时必选

参数解释:

标签的值。

约束限制:

标签的值可以重复,并且可以为空。

长度范围为0到43个字符。
不能包含非打印字ASCII(0-31)、“=”、“*”、“”、“\”。
区分大小写。

默认取值:

代码样例

本示例用于获取名为examplebucket的桶标签。

 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
from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
# 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS,则同样推荐通过环境变量获取
security_token = os.getenv("SecurityToken")
#  server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName="examplebucket"
    # 获取桶标签
    resp = obsClient.getBucketTagging(bucketName)
    # 返回码为2xx时,接口调用成功,否则接口调用失败
    if resp.status < 300:
        print('Get Bucket Tagging Succeeded')
        print('requestId:', resp.requestId)
        index = 1
        for tag in resp.body.tagSet:
            print('tag [' + str(index) + ']')
            print('key:', tag.key)
            print('value:', tag.value)
            index += 1
    else:
        print('Get Bucket Tagging Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Get Bucket Tagging Failed')
    print(traceback.format_exc())

相关链接

关于获取桶标签的API说明,请参见获取桶标签。
更多关于获取桶标签的示例代码,请参见Github示例。
获取桶标签过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
标签相关常见问题请参见标签相关常见问题。

父主题: 桶相关接口

同意关联代理商云淘科技,购买华为云产品更优惠(QQ 78315851)

内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家