九游平台/ 对象存储服务 obs/ sdk参考/ / / 设置桶标签(java sdk)
更新时间:2025-03-10 gmt 08:00

设置桶标签(java sdk)-九游平台

功能介绍

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

调用设置桶标签接口,您可为指定桶添加标签。

开发过程中,您有任何问题可以在github上,或者在中发帖求助。

接口约束

  • 每个桶最多能设置10个标签。
  • 您必须是桶拥有者或拥有设置桶标签的权限,才能设置桶标签。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:bucket:putbuckettagging权限,如果使用桶策略则需授予putbuckettagging权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
  • obs支持的region以及region与endpoint的对应关系,详细信息请参见。

方法定义

obsclient.setbuckettagging(final setbuckettaggingrequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

setbuckettaggingrequest

必选

参数解释

设置桶标签请求参数,详见setbuckettaggingrequest

表2 setbuckettaggingrequest

参数名称

参数类型

是否必选

描述

bucketname

string

必选

参数解释

桶名。

约束限制:

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

默认取值:

buckettaginfo

buckettaginfo

必选

参数解释

桶标签信息,详见buckettaginfo

表3 buckettaginfo

参数名称

参数类型

是否必选

描述

tagset

tagset

必选

参数解释

标签集,详见tagset

表4 tagset

参数名称

参数类型

是否必选

描述

tags

list<tag>

必选

参数解释

标签列表,标签信息详见tag

表5 tag

参数名称

参数类型

是否必选

描述

key

string

必选

参数解释:

标签的键。

约束限制:

  • 同一个桶标签的键不能重复。
  • 可以自定义,也可以选择预先在标签管理服务(tms)创建好的标签。
  • 长度范围为1-128个字符。
  • 支持unicode。
  • 不能以空格开头或结尾,不能包含字符“,”、“*”、“|”、“/”、“<”、“>”、“=”、“\”以及ascii码0x00--0x1f的控制字符,在发送到服务器之前,必须将键名(key)和键值(value)进行urlencode编码。
  • 区分大小写。

默认取值:

value

string

必选

参数解释:

标签的值。

约束限制:

  • 标签的值可以重复,并且可以为空。
  • 长度范围为0-255个字符。
  • 支持unicode。
  • 不能以空格开头或结尾,不能包含字符“,”、“*”、“|”、“/”、“<”、“>”、“=”、“\”以及ascii码0x00--0x1f的控制字符,在发送到服务器之前,必须将键名(key)和键值(value)进行urlencode编码。
  • 区分大小写。

默认取值:

返回结果说明

表6 返回结果headerresponse(sdk公共响应结果)各项属性说明

参数名称

参数类型

描述

statuscode

int

参数解释:

http状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。

完整的状态码列表请参见。

默认取值:

responseheaders

map

参数解释:

http响应消息头列表,由多个元组构成。元组中string代表响应消息头的名称,object代表响应消息头的值。

默认取值:

代码示例

本示例用于通过obsclient.setbuckettagging设置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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.buckettaginfo;
publicclass setbuckettagging001
{
publicstaticvoidmain(string[]args){
// 您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
// 您可以登录访问管理控制台获取访问密钥ak/sk
stringak=system.getenv("access_key_id");
stringsk=system.getenv("secret_access_key_id");
// 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。
// 您可以通过环境变量获取访问密钥ak/sk/securitytoken,也可以使用其他外部引入方式传入。
// string securitytoken = system.getenv("security_token");
// endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
stringendpoint="https://obs.cn-north-4.myhuaweicloud.com";
// 您可以通过环境变量获取endpoint,也可以使用其他外部引入方式传入。
//string endpoint = system.getenv("endpoint");
// 创建obsclient实例
// 使用永久ak/sk初始化客户端
obsclientobsclient=newobsclient(ak,sk,endpoint);
// 使用临时ak/sk和securitytoken初始化客户端
// obsclient obsclient = new obsclient(ak, sk, securitytoken, endpoint);
try{
// 设置桶标签
buckettaginfobuckettaginfo=newbuckettaginfo();
buckettaginfo.tagsettagset=newbuckettaginfo.tagset();
tagset.addtag("tag1","value1");
tagset.addtag("tag2","value2");
buckettaginfo.settagset(tagset);
obsclient.setbuckettagging("examplebucket",buckettaginfo);
system.out.println("setbuckettagging successfully");
}catch(obsexceptione){
system.out.println("setbuckettagging failed");
// 请求失败,打印http状态码
system.out.println("http code:"e.getresponsecode());
// 请求失败,打印服务端错误码
system.out.println("error code:"e.geterrorcode());
// 请求失败,打印详细错误信息
system.out.println("error message:"e.geterrormessage());
// 请求失败,打印请求id
system.out.println("request id:"e.geterrorrequestid());
system.out.println("host id:"e.geterrorhostid());
e.printstacktrace();
}catch(exceptione){
system.out.println("setbuckettagging failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

相关链接

  • 关于设置桶标签的api说明,请参见设置桶标签
  • 更多关于设置桶标签的示例代码,请参见。
  • 设置桶标签过程中返回的错误码含义、问题原因及处理措施可参考obs错误码

相关文档

网站地图