九游平台/ 对象存储服务 obs/ sdk参考/ / / 获取对象元数据(java sdk)
更新时间：2024-12-19 gmt 08:00

获取对象元数据(java sdk)-九游平台

功能说明

元数据（metadata）为描述对象属性的信息，是一组名称值对，用作对象管理的一部分。

拥有对象读权限的用户可以执行head操作命令获取对象元数据，返回信息包含对象的元数据信息。

该操作支持服务端加密功能。

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

接口约束

  • 您必须是桶拥有者或拥有获取对象元数据的权限，才能获取对象元数据。建议使用iam或桶策略进行授权，如果使用iam则需授予obs:object:getobject权限，如果使用桶策略则需授予getobject权限。相关授权方式介绍可参见obs权限控制概述，配置方式详见、。
  • obs支持的region以及region与endpoint的对应关系，详细信息请参见。
  • 您也可以通过metadata.getoriginalheaders获取所有原始响应头的信息。

方法定义

obsclient.getobjectmetadata(getobjectmetadatarequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

getobjectmetadatarequest

必选

参数解释：

获取对象元数据请求参数，详见表2。
表2 getobjectmetadatarequest

参数名称

参数类型

是否必选

描述

bucketname

string

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

objectkey

string

必选

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

versionid

string

可选

参数解释：

对象的版本号。

取值范围：

长度为32的字符串。

默认取值：

无

userheaders

hashmap

可选

参数解释：

用户头域列表。hashmap中第一个string代表用户头域名称，第二个string代表用户头域对应的取值。通过每个sdk设置的用户头域userheader透传给服务端，使sdk不做处理，让后续使用更灵活。

取值范围：

长度为32的字符串。

默认取值：

无

encodeheaders

boolean

可选

参数解释：

是否开启obs对请求头域的自动编码。

由于http编码规范限制，无法发送非ascii码字符，sdk会在发送请求时对您头域中的中文汉字进行url编码，发送编码后数据。如您设置的值content-disposition为attachment; filename="中文.txt"，则对象元数据中存储的信息为attachment; filename="中文.txt"。使用浏览器访问时浏览器将会自动解码。

取值范围：

true：启用sdk编码。

false：不启用sdk编码。

默认取值：

true

sseheader

ssecheader

可选

参数解释：

服务端解密头信息。详见ssecheader。
表3 ssecheader

参数名称

参数类型

是否必选

描述

algorithm

serveralgorithm

必选

参数解释：

表示服务端加密是sse-c方式，对象使用sse-c加密方式。

取值范围：

可选值：aes256，即选择sse-c方式，使用高级加密标准（advanced encryption standard，aes）加密对象。详见serveralgorithm。

默认取值：

无

ssealgorithm

ssealgorithmenum

可选

参数解释：

加密算法。

约束限制：

只支持aes256。

取值范围：

详见ssealgorithmenum。

默认取值：

无

sseckey

byte[]

必选

参数解释：

sse-c方式下加密使用的原始密钥，byte[]形式，该密钥用于加密对象。

默认取值：

无

sseckeybase64

string

可选

参数解释：

sse-c方式下的密钥，由原始密钥经过base64编码后得到，该密钥用于加密对象。

默认取值：

无
表4 serveralgorithm

常量值

原始值

aes256

aes256
表5 ssealgorithmenum

常量值

原始值

kms

kms

aes256

aes256

返回结果说明

表6 objectmetadata

参数名称

参数类型

是否必选

描述

contentlength

long

可选

参数解释：

对象数据的长度。

约束限制：

  • 单次上传对象大小范围是[0, 5gb]。
  • 如果需要上传超过5gb的大文件，需要通过来分段上传。

默认取值：

如果不设置，则sdk会自动计算对象数据的长度。

contenttype

string

可选

参数解释：

对象的文件类型（mime类型）。contenttype（mime）用于标识发送或接收数据的类型，浏览器根据该参数来决定数据的打开方式。

取值范围：

常见的contenttype（mime）列表参见。

默认取值：

如果未指定content-type，sdk会根据指定object名称的后缀来判定文件类型并自动填充content-type（如.xml判断为application/xml文件；.html判断为text/html文件）。

contentencoding

string

可选

参数解释：

响应中的content-encoding头。指定对象内容编码格式。

默认取值：

无

contentdisposition

string

可选

参数解释：

为请求的对象提供一个默认的文件名赋值给该对象，当下载对象或者访问对象时，以默认文件名命名的文件将直接在浏览器上显示，或在弹出文件下载对话框时显示。

默认取值：

无

cachecontrol

string

可选

参数解释：

响应中的cache-control头。指定对象被下载时的网页的缓存行为。

默认取值：

无

contentlanguage

string

可选

参数解释：

说明访问者希望采用的语言或语言组合，以根据自己偏好的语言来定制。详情请参见http协议中关于contentlanguage的定义。

默认取值：

无

expires

string

可选

参数解释：

指对象在网页中的缓存过期时间。

约束限制：

日期格式为gmt的格式。

默认取值：

无

contentmd5

string

可选

参数解释：

对象数据的md5值（经过base64编码），提供给obs服务端，校验数据完整性。obs服务端会将该md5值与对象数据计算出的md5值进行对比，如果不匹配则上传失败，返回http 400错误。

约束限制：

  • 对象数据的md5值必须经过base64编码。
  • 如果不设置对象的md5值，obs服务端会忽略对对象数据的md5值校验。

取值范围：

按照rfc 1864标准计算出消息体的md5摘要字符串，即消息体128-bit md5值经过base64编码后得到的字符串。

示例：n58ig6hfm7vqi4k0vnwpog==

默认取值：

无

storageclass

storageclassenum

可选

参数解释：

对象的存储类别。创建对象时，可以加上此头域设置对象的存储类别。如果未设置此头域，则以桶的默认存储类别作为对象的存储类别。

取值范围：

  • 当对象存储类型是标准存储时，该值为空。
  • 可选择的存储类别参见storageclassenum。

默认取值：

无

websiteredirectlocation

string

可选

参数解释：

当桶设置了website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的url，该参数指明对象的重定向地址。

例如，重定向请求到桶内另一对象：

websiteredirectlocation:/anotherpage.html

或重定向请求到一个外部url：

websiteredirectlocation:http://www.example.com/

约束限制：

  • 必须以“/”、“http://”或“https://”开头，长度不超过2kb。
  • obs仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。

默认取值：

无

nextposition

long

可选

参数解释：

下次追加上传的位置。

取值范围：

0~对象长度，单位：字节。

默认取值：

无

appendable

boolean

可选

参数解释：

对象是否为可追加上传的对象。

取值范围：

true：是，可追加上传。

false：否，不可追加上传。

默认取值：

无

usermetadata

map

可选

参数解释：

对象的自定义元数据，obs支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。map中的string代表以“x-obs-meta-”开头的自定义元数据名称，object代表自定义元数据的值。对象的自定义元数据可以通过obsclient.getobjectmetadata获取，参见获取对象元数据。

约束限制：

  • 一个对象可以有多个元数据，总大小不能超过8kb。
  • 使用obsclient.getobject下载对象时，对象的自定义元数据也会同时下载。

默认取值：

无
表7 storageclassenum

常量名

原始值

说明

standard

standard

标准存储。

warm

warm

低频访问存储。

cold

cold

归档存储。

deep_archive

deep_archive

深度归档存储（受限公测）

代码示例

本示例展示了如何获取examplebucket桶下objectname对象的元数据。示例代码如下：

 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.objectmetadata;
publicclass getobjectmetadata001{
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{
// 获取对象元数据
objectmetadatametadata=obsclient.getobjectmetadata("examplebucket","objectname");
system.out.println("getobjectmetadata successfully");
system.out.println("contenttype:"metadata.getcontenttype());
system.out.println("contentlength:"metadata.getcontentlength());
// 获取用户自定义元数据
system.out.println("usermetadata:"metadata.getusermetadata("property"));
// 获取所有原始响应头域
system.out.println("originalheaders:"metadata.getoriginalheaders());
}catch(obsexceptione){
system.out.println("getobjectmetadata 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("getobjectmetadata failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

相关链接

  • 关于获取对象元数据的api说明，请参见获取对象元数据。
  • 更多关于获取对象元数据的示例代码，请参见。
  • 获取对象元数据过程中返回的错误码含义、问题原因及处理措施可参考obs错误码。
父主题：

相关文档

网站地图