九游平台/ 对象存储服务 obs/ sdk参考/ / / 设置跨域资源共享规则(java sdk)
更新时间:2024-11-06 gmt 08:00

设置跨域资源共享规则(java sdk)-九游平台

功能介绍

跨域资源共享(cross origin resource sharing,cors)是由w3c标准化组织提出的一种网络浏览器的规范机制,定义了一个域中加载的客户端web应用程序与另一个域中的资源交互的方式。而在通常的网页请求中,由于同源安全策略(same origin policy,sop)的存在,不同域之间的网站脚本和内容是无法进行交互的。obs支持cors规范,允许跨域请求访问obs中的资源。

您可以通过obsclient.setbucketcors设置桶的跨域规则,如果原规则存在则覆盖原规则。

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

接口约束

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

方法定义

obsclient.setbucketcors(final setbucketcorsrequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

setbucketcorsrequest

必选

设置跨域规则请求参数,详见setbucketcorsrequest

表2 setbucketcorsrequest

参数名称

参数类型

是否必选

描述

bucketname

string

必选

参数解释

桶名。

约束限制:

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

默认取值:

bucketcors

bucketcors

必选

参数解释

桶的cors规则列表。详见bucketcors

表3 bucketcors

参数名称

参数类型

是否必选

描述

rules

list<bucketcorsrule>

必选

参数解释

桶的cors规则列表。详见bucketcorsrule

表4 bucketcorsrule

参数名称

参数类型

是否必选

描述

id

string

可选

参数解释:

cors规则id

取值范围:

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

默认取值:

allowedmethod

list

必选

参数解释:

指定允许的跨域请求http方法,即桶和对象的几种操作类型。

取值范围:

支持以下http方法:

  • get
  • put
  • head
  • post
  • delete

默认取值:

allowedorigin

list

必选

参数解释:

指定允许的跨域请求的来源,即允许来自该域名下的请求访问该桶。

约束限制:

表示域名的字符串,每个匹配规则允许使用最多一个“*”通配符。例如:https://*.vbs.example.com。

默认取值:

allowedheader

list

可选

参数解释:

指定允许的跨域请求的头域。只有匹配上允许的头域中的配置,才被视为是合法的cors请求。

约束限制:

最多可填写一个“*”通配符,不支持&、:、<、空格以及中文字符。

默认取值:

maxageseconds

int

可选

参数解释:

cors规则允许客户端可以对跨域请求返回结果的缓存时间。

约束限制:

每个bucketcorsrule可以包含至多一个maxageseconds。

取值范围:

不小于0的整型数,单位:秒。

默认取值:

100

exposeheader

list

可选

参数解释:

cors规则允许响应中可返回的附加头域,给客户端提供额外的信息。默认情况下浏览器只能访问以下头域:content-length、content-type,如果需要访问其他头域,需要在附加头域中配置。

约束限制:

不支持*、&、:、<、空格以及中文字符。

默认取值:

返回结果说明

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

参数名称

参数类型

描述

statuscode

int

参数解释:

http状态码。

取值范围:

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

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

默认取值:

responseheaders

map

参数解释:

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

默认取值:

代码示例

本示例用于配置examplebucket桶的cors规则。

 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.bucketcors;
importcom.obs.services.model.bucketcorsrule;
importcom.obs.services.model.deleteobjectsrequest;
importcom.obs.services.model.deleteobjectsresult;
importcom.obs.services.model.keyandversion;
importjava.util.arraylist;
importjava.util.list;
publicclass setbucketcors001{
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{
// 设置跨域规则
bucketcorscors=newbucketcors();
list<bucketcorsrule>rules=newarraylist<bucketcorsrule>();
bucketcorsrulerule=newbucketcorsrule();
arraylist<string>allowedorigin=newarraylist<string>();
// 指定允许跨域请求的来源
allowedorigin.add("http://www.a.com");
allowedorigin.add("http://www.b.com");
rule.setallowedorigin(allowedorigin);
arraylist<string>allowedmethod=newarraylist<string>();
// 指定允许的跨域请求方法(get/put/delete/post/head)
allowedmethod.add("get");
allowedmethod.add("head");
allowedmethod.add("put");
rule.setallowedmethod(allowedmethod);
arraylist<string>allowedheader=newarraylist<string>();
// 控制在options预取指令中access-control-request-headers头中指定的header是否被允许使用
allowedheader.add("x-obs-header");
rule.setallowedheader(allowedheader);
arraylist<string>exposeheader=newarraylist<string>();
// 指定允许用户从应用程序中访问的header
exposeheader.add("x-obs-expose-header");
rule.setexposeheader(exposeheader);
// 指定浏览器对特定资源的预取(options)请求返回结果的缓存时间,单位为秒
rule.setmaxagesecond(10);
rules.add(rule);
cors.setrules(rules);
obsclient.setbucketcors("examplebucket",cors);
system.out.println("setbucketcors successfully");
}catch(obsexceptione){
system.out.println("setbucketcors 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("setbucketcors failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

相关链接

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

相关文档

网站地图