更新时间:2024-12-19 gmt 08:00

设置对象元数据(java sdk)-九游平台

功能说明

您可以在上传对象时设置对象元数据。对象元数据包含对象长度、对象mime类型、对象md5值(用于校验)、对象存储类别、对象自定义元数据。对象元数据可以在多种上传方式下(流式上传、文件上传、分段上传),或复制对象时进行设置。

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

接口约束

  • 您必须是桶拥有者或拥有上传对象的权限,才能上传时设置对象元数据。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:object:putobject权限,如果使用桶策略则需授予putobject权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
  • obs支持的region以及region与endpoint的对应关系,详细信息请参见。
  • 一个对象可以有多个元数据,总大小不能超过8kb。
  • 当前元数据名称不支持非ascii码字符,元数据值包含非ascii码字符时需进行base64编码。

方法定义

obsclient.putobject(putobjectrequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

putobjectrequest

必选

参数解释

上传对象请求参数,详见putobjectrequest

表2 putobjectrequest

参数名称

参数类型

是否必选

描述

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的字符串。

默认取值:

metadata

objectmetadata

可选

参数解释:

对象元数据,详见objectmetadata

默认取值:

acl

accesscontrollist

可选

参数解释:

创建对象时可指定的预定义访问策略,可选择的访问策略选项参见accesscontrollist,有关访问控制列表(access control list,acl)功能的详细信息可参见acl功能介绍

取值范围:

默认取值:

ssekmsheader

ssekmsheader

可选

参数解释:

服务端加密头信息。详见ssekmsheader

默认取值:

ssecheader

ssecheader

可选

参数解释:

服务端加密头信息。详见ssecheader

默认取值:

input

java.io.inputstream

可选

参数解释:

待上传对象的数据流。

默认取值:

file

java.io.file

可选

参数解释:

待上传对象的文件。

默认取值:

extensionpermissionmap

map<extensionobjectpermissionenum, set>

可选

参数解释:

桶acl的授权map,您可以为一个或多个账号授予桶权限。map的extensionobjectpermissionenum用于指定权限,map的set用于说明该权限授予的账号id列表,即domain_id列表。

取值范围:

默认取值:

expires

int

可选

参数解释:

表示对象的过期时间(从对象最后修改时间开始计算)。过期之后对象会被自动删除。

约束限制:

此字段对于每个对象支持上传时配置,也支持后期通过修改元数据接口附带头域x-obs-expires修改。

取值范围:

大于0的整型数,单位:天。

默认取值:

progresslistener

progresslistener

可选

参数解释:

上传进度,详见progresslistener

encodeheaders

boolean

可选

参数解释:

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

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

取值范围:

true:启用sdk编码。

false:不启用sdk编码。

默认取值:

true

表3 acl预定义访问策略

常量名

说明

accesscontrollist.rest_canned_private

私有读写。

桶或对象的所有者拥有完全控制的权限,其他任何人都没有访问权限。

accesscontrollist.rest_canned_public_read

公共读。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。

设在对象上,所有人可以获取该对象内容和元数据。

accesscontrollist.rest_canned_public_read_write

公共读写。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、上传对象删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务。

设在对象上,所有人可以获取该对象内容和元数据。

accesscontrollist.rest_canned_public_read_delivered

桶公共读,桶内对象公共读。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据,可以获取该桶内对象的内容和元数据。

不能应用于对象。

accesscontrollist.rest_canned_public_read_write_delivered

桶公共读写,桶内对象公共读写。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务,可以获取该桶内对象的内容和元数据。

不能应用于对象。

表4 progresslistener(传输进度接口)成员如下

方法名称

返回值类型

是否必选

描述

progresschanged

void

必选

参数解释:

获取上传进度,详见progresschanged

默认取值:

表5 progresschanged参数列表

参数名称

参数类型

是否必选

描述

status

progressstatus

必选

参数解释:

传输进度数据,详见progressstatus

默认取值:

表6 progressstatus方法

方法名称

返回值类型

说明

getaveragespeed()

double

上传平均速率。

getinstantaneousspeed()

double

上传瞬时速率。

gettransferpercentage()

int

上传进度百分比。

getnewlytransferredbytes()

long

新增的字节数。

gettransferredbytes()

long

已传输的字节数。

gettotalbytes()

long

待传输的字节数。

表7 extensionobjectpermissionenum

常量值

说明

grant_read

授权指定租户有读对象和获取对象元数据的权限。

grant_read_acp

授权指定租户有获取对象acl的权限。

grant_write_acp

授权指定租户有写对象acl的权限。

grant_full_control

授权指定租户有读对象、获取对象元数据、获取对象acl、写对象acl的权限。

表8 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编码后得到,该密钥用于加密对象。

默认取值:

表9 ssekmsheader

参数名称

参数类型

是否必选

描述

encryption

serverencryption

必选

参数解释:

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

取值范围:

可选值:kms,即选择sse-kms方式加密对象,详见serverencryption

默认取值:

ssealgorithm

ssealgorithmenum

可选

参数解释:

加密算法。

约束限制:

只支持kms。

取值范围:

详见ssealgorithmenum

默认取值:

kmskeyid

string

可选

参数解释:

sse-kms加密方式下使用的kms主密钥的id值。

取值范围:

有效值支持两种格式:

  1. regionid:domainid(账号id):key/key_id
  2. key_id

其中:

  • regionid是使用密钥所属region的id,可在页面获取;
  • domainid是使用密钥所属账号的账号id,获取方法参见;
  • key_id是从数据加密服务创建的密钥id,获取方法请参见查看密钥

默认取值:

  • 如果用户没有提供该头域,那么默认的主密钥将会被使用。
  • 如果默认主密钥不存在,将默认创建并使用。
表10 serveralgorithm

常量值

原始值

aes256

aes256

表11 serverencryption

常量值

原始值

obs_kms

kms

表12 ssealgorithmenum

常量值

原始值

kms

kms

aes256

aes256

表13 storageclassenum

常量名

原始值

说明

standard

standard

标准存储。

warm

warm

低频访问存储。

cold

cold

归档存储。

deep_archive

deep_archive

深度归档存储(受限公测)

表14 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下载对象时,对象的自定义元数据也会同时下载。

认取值:

表15 accesscontrollist

参数名称

参数类型

是否必选

参数类型

owner

owner

可选

参数解释

桶所有者的信息,详见owner

delivered

boolean

可选

参数解释:

桶的acl是否向桶内对象传递,作用于桶内所有对象。

取值范围:

true:是,桶acl向桶内对象传递。

false:否,桶acl不向桶内对象传递,仅作用于桶。

默认取值:

false

grants

set<grantandpermission>

可选

参数解释:

被授权用户相关信息,详见grantandpermission

表16 owner

参数名称

参数类型

是否必选

描述

id

string

必选

参数解释

桶所有者的账号id,即domain_id。

取值范围:

如何获取账号id请参见。

默认取值:

displayname

string

可选

参数解释:

所有者的账号名。

取值范围:

如何获取账号名请参见。

默认取值:

表17 grantandpermission

参数名称

参数类型

是否必选

描述

grantee

granteeinterface

必选

参数解释:

被授权用户或用户组,详见granteeinterface

permission

permission

必选

参数解释:

用户或用户组被授予的权限。

取值范围:

详见permission

默认取值:

delivered

boolean

可选

参数解释:

桶的acl是否向桶内对象传递,作用于桶内所有对象。

取值范围:

true:是,桶acl向桶内对象传递。

false:否,桶acl不向桶内对象传递,仅作用于桶。

默认取值:

false

表18 permission

常量名

原始值

说明

permission_read

read

读权限。

如果有桶的读权限,则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。

如果有对象的读权限,则可以获取该对象内容和元数据。

permission_write

write

写权限。

如果有桶的写权限,则可以上传、覆盖和删除该桶内任何对象和段。

此权限在对象上不适用。

permission_read_acp

read_acp

读取acl配置的权限。

如果有读acp的权限,则可以获取对应的桶或对象的权限控制列表(acl)。

桶或对象的所有者永远拥有读对应桶或对象acp的权限。

permission_write_acp

write_acp

修改acl配置的权限。

如果有写acp的权限,则可以更新对应桶或对象的权限控制列表(acl)。

桶或对象的所有者永远拥有写对应桶或对象的acp的权限。

拥有了写acp的权限,由于可以更改权限控制策略,实际上意味着拥有了完全访问的权限。

permission_full_control

full_control

完全控制权限,包括对桶或对象的读写权限,以及对桶或对象acl配置的读写权限。

如果有桶的完全控制权限意味着拥有read、write、read_acp和write_acp的权限。

如果有对象的完全控制权限意味着拥有read、read_acp和write_acp的权限。

表19 granteeinterface

参数名称

参数类型

是否必选

描述

canonicalgrantee

canonicalgrantee

必选

参数解释:

被授权用户的用户信息,详见canonicalgrantee

groupgrantee

groupgrantee

必选

参数解释:

被授权用户组的用户组信息。

取值范围:

详见groupgrantee

默认取值:

表20 canonicalgrantee

参数名称

参数类型

是否必选

描述

grantid

string

如果type为用户类型则必选

参数解释:

被授权用户的账号id,即domain_id。

取值范围:

如何获取账号id请参见。

默认取值:

displayname

string

可选

参数描述:

被授权用户的账号名。

取值范围:

如何获取账号名请参见。

默认取值:

表21 groupgrantee

常量名

说明

all_users

所有用户。

authenticated_users

授权用户,已废弃。

log_delivery

日志投递组,已废弃。

返回结果说明

表22 putobjectresult

参数名称

参数类型

描述

statuscode

int

参数解释:

http状态码。

取值范围:

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

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

默认取值:

responseheaders

map

参数解释:

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

默认取值:

storageclass

storageclassenum

参数解释:

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

取值范围:

可选择的存储类别参见storageclassenum

默认取值:

versionid

string

参数解释:

对象的版本号。如果桶的多版本状态为开启,则会返回对象的版本号。

取值范围:

长度为32的字符串。

默认取值:

etag

string

参数解释:

对象的etag值,即base64编码的128位md5摘要。etag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时etag为a,下载对象时etag为b,则说明对象内容发生了变化。etag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,都有唯一的etag。

约束限制:

当对象是服务端加密的对象时,etag值不是对象的md5值。

取值范围:

长度为32的字符串。

默认取值:

objectkey

string

参数解释:

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

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

取值范围:

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

默认取值:

bucketname

string

参数解释

桶名。

约束限制:

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

默认取值:

代码示例:设置对象长度

本示例用于设置对象长度。将本地文件localfile上传到桶examplebucket中,将此对象命名为objectname,同时将objectname对象长度设置为1024 * 1024l。

 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
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.objectmetadata;
importjava.io.file;
importjava.io.ioexception;
publicclass putobject007{
publicstaticvoidmain(string[]args)throwsioexception{
// 您可以通过环境变量获取访问密钥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=newobjectmetadata();
metadata.setcontentlength(1024*1024l);// 1mb
obsclient.putobject("examplebucket","objectname",newfile("localfile"),metadata);
system.out.println("putobject successfully");
}catch(obsexceptione){
system.out.println("putobject 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("putobject failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

代码示例:设置对象mime类型

本示例通过设置对象mime类型为image/jpeg,将本地文件localimage.jpg上传到examplebucket桶下的objectname.jpg对象中。

 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
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.objectmetadata;
importjava.io.file;
publicclass putobject008{
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{
// 设置对象mime类型
// 上传图片
objectmetadatametadata=newobjectmetadata();
metadata.setcontenttype("image/jpeg");
obsclient.putobject("examplebucket","objectname.jpg",newfile("localimage.jpg"),metadata);
system.out.println("putobject successfully");
}catch(obsexceptione){
system.out.println("putobject 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("putobject failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

代码示例:设置对象md5值

本示例用于通过obsclient.base64md5来直接计算content-md5头域,将本地文件localimage.jpg上传到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
53
54
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.objectmetadata;
importjava.io.file;
importjava.nio.file.files;
importjava.nio.file.paths;
publicclass putobject009{
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{
// 设置对象md5值
// 上传图片
objectmetadatametadata=newobjectmetadata();
//your file's md5 which encoded by base64
stringbase64md5=obsclient.base64md5(files.newinputstream(paths.get("localimage.jpg")));
metadata.setcontentmd5(base64md5);
obsclient.putobject("examplebucket","objectname",newfile("localimage.jpg"),metadata);
system.out.println("putobject successfully");
}catch(obsexceptione){
system.out.println("putobject 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("putobject failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

代码示例:设置对象自定义元数据

本示例用于设置对象自定义元数据,用户自定义了一个名称为“property1”,值为“property-value1”的元数据和一个名称为“property2”,值为“property-value2”的元数据。将localfile上传到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
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.objectmetadata;
importjava.io.file;
publicclass putobject011{
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=newobjectmetadata();
metadata.addusermetadata("property1","property-value1");
metadata.getmetadata().put("property2","property-value2");
obsclient.putobject("examplebucket","objectname",newfile("localfile"),metadata);
system.out.println("putobject successfully");
}catch(obsexceptione){
system.out.println("putobject 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("putobject failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

代码示例:设置对象存储类别

本示例用于设置对象存储类别。将本地文件localfile上传到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
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.objectmetadata;
importcom.obs.services.model.storageclassenum;
importjava.io.file;
publicclass putobject010{
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=newobjectmetadata();
// 设置对象存储类别为低频访问存储
metadata.setobjectstorageclass(storageclassenum.warm);
obsclient.putobject("examplebucket","objectname",newfile("localfile"),metadata);
system.out.println("putobject successfully");
}catch(obsexceptione){
system.out.println("putobject 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("putobject failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

相关链接

  • 更多关于设置对象元数据的示例代码,请参见。
  • 设置对象元数据过程中返回的错误码含义、问题原因及处理措施可参考obs错误码

相关文档

网站地图