获取桶元数据(java sdk)-九游平台
功能说明
调用获取桶元数据接口,可获取指定桶的相关信息,包括指定桶的存储类别、区域位置、跨域资源共享(cors)规则、冗余策略等信息。

开发过程中,您有任何问题可以在github上,或者在中发帖求助。
接口约束
- 您必须是桶拥有者或拥有获取桶元数据的权限,才能获取桶元数据。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:bucket:headbucket权限,如果使用桶策略则需授予headbucket权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
- obs支持的region以及region与endpoint的对应关系,详细信息请参见。
- bucketmetadatainforesult.getallowmethods等方法的值参见桶的(cors)配置。
方法定义
obsclient.getbucketmetadata(bucketmetadatainforequest request)
请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
request |
必选 |
参数解释: 获取桶元数据请求参数,详bucketmetadatainforequest。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketname |
string |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
origin |
string |
可选 |
参数解释: 预请求指定的跨域请求origin(通常为域名)。 约束限制: 允许多条匹配规则,以回车换行为间隔。每个匹配规则允许使用最多一个“*”通配符。 默认取值: 无 |
requestheaders |
list |
可选 |
参数解释: 跨域请求可以使用的http头域。只有匹配上允许的头域中的配置,才被视为是合法的cors请求。 约束限制: 允许的头域可设置多个,多个头域之间换行隔开,每行最多可填写一个*符号,不支持&、:、<、空格以及中文字符。 默认取值: 无 |
返回结果说明
参数名称 |
参数类型 |
描述 |
---|---|---|
statuscode |
int |
参数解释: http状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。 完整的状态码列表请参见。 默认取值: 无 |
responseheaders |
map |
参数解释: http响应消息头列表,由多个元组构成。元组中string代表响应消息头的名称,object代表响应消息头的值。默认取值: 无 |
location |
string |
参数解释: 桶所在的区域。 约束限制: 该参数定义了桶将会被创建在哪个区域,如果使用的终端节点是obs.myhuaweicloud.com,可以不携带此参数;如果使用的终端节点不是obs.myhuaweicloud.com,则必须携带此参数。 取值范围: 当前有效的obs区域和终端节点的更多信息,请参考。终端节点即调用api的请求地址,不同服务不同区域的终端节点不同,您可以向企业管理员获取区域和终端节点信息。 默认取值: 终端节点为obs.myhuaweicloud.com且用户未设定区域时,默认为华北-北京一(cn-north-1)。 |
obsversion |
string |
参数解释: 桶所在的obs服务版本号。 取值范围:
默认取值: 无 |
storageclass |
参数解释: 创桶时可指定的桶的存储类别。 取值范围: 可选择的访问策略选项参见storageclassenum。 默认取值: standard,即标准存储类别。 |
|
alloworigin |
string |
参数解释: 如果请求中的origin满足桶的cors规则,则返回cors规则中的allowedorigin。 约束限制: 允许多条匹配规则,以回车换行为间隔。每个匹配规则允许使用最多一个“*”通配符。 默认取值: 无 |
allowheaders |
list |
参数解释: 如果请求中的requestheader满足桶的cors规则,则返回cors规则中的allowedheader。 约束限制: 允许的头域可设置多个,多个头域之间换行隔开,每行最多可填写一个*符号,不支持&、:、<、空格以及中文字符。 默认取值: 无 |
allowmethods |
list |
参数解释: 指定允许的跨域请求http方法,即桶和对象的几种操作类型。 取值范围: 支持以下http方法:
默认取值: 无 |
exposeheaders |
list |
参数解释: cors规则允许响应中可返回的附加头域,给客户端提供额外的信息。默认情况下浏览器只能访问以下头域:content-length、content-type,如果需要访问其他头域,需要在附加头域中配置。 约束限制: 不支持*、&、:、<、空格以及中文字符。 默认取值: 无 |
maxage |
int |
参数解释: 请求来源的客户端可以对跨域请求返回结果的缓存时间。 约束限制: 每个corsrule可以包含至多一个maxage。 取值范围: 大于0的整型数,单位:秒。 默认取值: 100 |
epid |
string |
参数解释: 创桶时可指定的企业项目id,开通企业项目的用户可以从企业项目服务获取。 约束限制: epid格式为uuid,默认项目传“0”或者不带该头域,未开通企业项目的用户可以不带该头域。 示例:9892d768-2d13-450f-aac7-ed0e44c2585f 取值范围: 获取方式参见如何获取企业项目id 。 默认取值: 无 |
buckettype |
参数解释: 创建的桶类型。 取值范围: 默认取值: object,即对象桶。 |
|
availablezone |
参数解释: 桶的数据冗余存储策略属性,反映数据是单az存储还是多az存储。详见availablezoneenum 约束限制: 取值为3az,表示数据冗余存储在同一区域的多个可用区。 不携带此头域表示为单az存储,仅使用1个可用区存储。 默认取值: 无 |
常量名 |
原始值 |
说明 |
---|---|---|
object |
object |
对象桶 |
pfs |
posix |
并行文件系统 |
常量名 |
原始值 |
说明 |
---|---|---|
multi_az |
3az |
多az类型 |
常量名 |
原始值 |
说明 |
---|---|---|
standard |
standard |
标准存储。 |
warm |
warm |
低频访问存储。 |
cold |
cold |
归档存储。 |
deep_archive |
deep_archive |
深度归档存储(受限公测) |
代码示例
本示例用于获取examplebucke桶的元数据信息,指定的跨域请求origin为“http://www.exampleorigin.com”。
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 53 54 55 56 57 58 59 60 61 62 63 |
importcom.obs.services.obsclient; importcom.obs.services.exception.obsexception; importcom.obs.services.model.bucketmetadatainforequest; importcom.obs.services.model.bucketmetadatainforesult; publicclass getbucketmetadata001{ 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{ //示例桶名 stringexamplebucket="examplebucket"; //示例origin stringexampleorigin="http://www.exampleorigin.com"; bucketmetadatainforequestrequest=newbucketmetadatainforequest(examplebucket); //只有在涉及 cors 时才需要 setorigin request.setorigin(exampleorigin); // 获取桶元数据 bucketmetadatainforesultresult=obsclient.getbucketmetadata(request); system.out.println("getbucketmetadata successfully"); system.out.println("getbuckettype:"result.getbuckettype()); system.out.println("getlocation:"result.getlocation()); system.out.println("getbucketstorageclass:"result.getbucketstorageclass()); system.out.println("getobsversion:"result.getobsversion()); system.out.println("getalloworigin:"result.getalloworigin()); system.out.println("getmaxage:"result.getmaxage()); system.out.println("getallowheaders:"result.getallowheaders()); system.out.println("getallowmethods:"result.getallowmethods()); system.out.println("getexposeheaders:"result.getexposeheaders()); }catch(obsexceptione){ system.out.println("getbucketmetadata 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("getbucketmetadata failed"); // 其他异常信息打印 e.printstacktrace(); } } } |
相关链接
- 关于获取桶元数据的api说明,请参见获取桶元数据。
- 更多关于获取桶元数据的示例代码,请参见。
- 获取桶元数据过程中返回的错误码含义、问题原因及处理措施可参考obs错误码。
- 桶和对象相关常见问题请参见桶和对象相关常见问题。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨