获取跨域资源共享规则(Java SDK)
功能介绍
跨域资源共享(Cross Origin Resource Sharing,CORS)是由W3C标准化组织提出的一种网络浏览器的规范机制,定义了一个域中加载的客户端Web应用程序与另一个域中的资源交互的方式。而在通常的网页请求中,由于同源安全策略(Same Origin Policy,SOP)的存在,不同域之间的网站脚本和内容是无法进行交互的。OBS支持CORS规范,允许跨域请求访问OBS中的资源。
调用获取桶的CORS配置接口,您可获取指定桶的跨域资源共享规则。
开发过程中,您有任何问题可以在github上提交issue。
接口约束
- 您必须是桶拥有者或拥有获取桶的CORS配置的权限,才能获取桶的CORS配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketCORS权限,如果使用桶策略则需授予GetBucketCORS权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
方法定义
obsclient.getBucketCors(final BaseBucketRequest request)
请求参数说明
返回结果说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
rules |
List<BucketCorsRule> |
必选 |
参数解释: 桶的CORS规则列表。详见BucketCorsRule。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
id |
String |
可选 |
参数解释: CORS规则ID 取值范围: 长度大于0且不超过255的字符串。 默认取值: 无 |
allowedMethod |
List<String> |
必选 |
参数解释: 指定允许的跨域请求HTTP方法,即桶和对象的几种操作类型。 取值范围: 支持以下HTTP方法:
默认取值: 无 |
allowedOrigin |
List<String> |
必选 |
参数解释: 指定允许的跨域请求的来源,即允许来自该域名下的请求访问该桶。 约束限制: 表示域名的字符串,每个匹配规则允许使用最多一个“*”通配符。例如:https://*.vbs.example.com。 默认取值: 无 |
allowedHeader |
List<String> |
可选 |
参数解释: 指定允许的跨域请求的头域。只有匹配上允许的头域中的配置,才被视为是合法的CORS请求。 约束限制: 最多可填写一个“*”通配符,不支持&、:、<、空格以及中文字符。 默认取值: 无 |
maxAgeSeconds |
int |
可选 |
参数解释: CORS规则允许客户端可以对跨域请求返回结果的缓存时间。 约束限制: 每个BucketCorsRule可以包含至多一个maxAgeSeconds。 取值范围: 不小于0的整型数,单位:秒。 默认取值: 100 |
exposeHeader |
List<String> |
可选 |
参数解释: CORS规则允许响应中可返回的附加头域,给客户端提供额外的信息。默认情况下浏览器只能访问以下头域:Content-Length、Content-Type,如果需要访问其他头域,需要在附加头域中配置。 约束限制: 不支持*、&、:、<、空格以及中文字符。 默认取值: 无 |
代码示例
本示例用于获取名为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 |
import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.BucketCors; import com.obs.services.model.BucketCorsRule; public class GetBucketCors001 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken,也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以中国-香港为例,其他地区请按实际情况填写。 String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 获取跨域规则 BucketCors cors = obsClient.getBucketCors("examplebucket"); for(BucketCorsRule rule : cors.getRules()){ System.out.println("Id:" + rule.getId()); System.out.println("MaxAgeSecond:" + rule.getMaxAgeSecond()); System.out.println("AllowedHeader:" + rule.getAllowedHeader()); System.out.println("AllowedOrigin:" + rule.getAllowedOrigin()); System.out.println("AllowedMethod:" + rule.getAllowedMethod()); System.out.println("ExposeHeader:" + rule.getExposeHeader()); } System.out.println("getBucketCors successfully"); } catch (ObsException e) { System.out.println("getBucketCors 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 (Exception e) { System.out.println("getBucketCors failed"); // 其他异常信息打印 e.printStackTrace(); } } } |
相关链接
- 关于获取桶的跨域规则的API说明,请参见获取桶的CORS配置。
- 更多关于获取桶的跨域规则的示例代码,请参见Github示例。
- 获取桶的跨域规则过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。