设置桶的CORS配置(Harmony SDK)
功能介绍
跨域资源共享(Cross Origin Resource Sharing,CORS)是由W3C标准化组织提出的一种网络浏览器的规范机制,定义了一个域中加载的客户端Web应用程序与另一个域中的资源交互的方式。而在通常的网页请求中,由于同源安全策略(Same Origin Policy,SOP)的存在,不同域之间的网站脚本和内容是无法进行交互的。OBS支持CORS规范,允许跨域请求访问OBS中的资源。
调用设置桶的CORS配置接口,您可设置指定桶的跨域资源共享规则,以允许客户端浏览器进行跨域请求。
接口约束
- 您必须是桶拥有者或拥有设置桶的CORS配置的权限,才能设置桶的CORS配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:PutBucketCORS权限,如果使用桶策略则需授予PutBucketCORS权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
setBucketCors(input: SetBucketCorsInput): Response<BaseResponseOutput>
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
input |
必选 |
参数解释: 设置桶的CORS配置接口入参,详见SetBucketCorsInput。 |
参数名称 |
参数类型 |
是否可选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
桶名。 约束限制:
取值范围: 长度为3~63个字符。 |
CorsRules |
CorsRule[] |
必选 |
参数解释: 桶的CORS规则列表,详见CorsRule。 约束限制: 列表最多包含100个规则。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
ID |
string |
作为请求参数时可选 |
参数解释: CORS规则ID。 取值范围: 长度大于0且不超过255的字符串。 默认取值: 无 |
AllowedMethod |
string[] |
作为请求参数时必选 |
参数解释: 指定允许的跨域请求HTTP方法,即桶和对象的几种操作类型。 取值范围: 支持以下HTTP方法:
默认取值: 无 |
AllowedOrigin |
string[] |
作为请求参数时必选 |
参数解释: 指定允许的跨域请求的来源,即允许来自该域名下的请求访问该桶。 约束限制: 表示域名的字符串,每个匹配规则允许使用最多一个“*”通配符。例如:https://*.vbs.example.com。 默认取值: 无 |
AllowedHeader |
string[] |
作为请求参数时可选 |
参数解释: 指定允许的跨域请求的头域。只有匹配上允许的头域中的配置,才被视为是合法的CORS请求。 约束限制: 最多可填写一个“*”通配符,不支持&、:、<、空格以及中文字符。 默认取值: 无 |
MaxAgeSeconds |
number |
作为请求参数时可选 |
参数解释: 请求来源的客户端可以对跨域请求返回结果的缓存时间。 约束限制: 每个CORSRule可以包含至多一个MaxAgeSeconds。 取值范围: 0~(231-1),单位:秒。 默认取值: 100 |
ExposeHeader |
string[] |
作为请求参数时可选 |
参数解释: CORS规则允许响应中可返回的附加头域,给客户端提供额外的信息。默认情况下浏览器只能访问以下头域:Content-Length、Content-Type,如果需要访问其他头域,需要在附加头域中配置。 约束限制: 不支持*、&、:、<、空格以及中文字符。 默认取值: 无 |
返回结果
参数类型 |
描述 |
---|---|
说明:
该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。 |
参数解释: 接口返回信息,详见Response。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
CommonMsg |
参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 |
|
InterfaceResult |
参数解释: 操作成功后的结果数据,详见BaseResponseOutput。 约束限制: 当Status大于300时为空。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
Status |
number |
参数解释: OBS服务端返回的HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 |
Code |
string |
参数解释: OBS服务端返回的错误码。 |
Message |
string |
参数解释: OBS服务端返回的错误描述。 |
HostId |
string |
参数解释: OBS服务端返回的请求服务端ID。 |
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 |
Id2 |
string |
参数解释: OBS服务端返回的请求ID2。 |
Indicator |
string |
参数解释: OBS服务端返回的详细错误码。 |
代码示例
本示例用于设置名为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 ObsClient, { SetBucketCorsInput } from '@obs/esdk-obs-harmony'; // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: process.env.ACCESS_KEY_ID, SecretAccessKey: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入 // SecurityToken: process.env.SECURITY_TOKEN, // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function setBucketCors() { try { const params: SetBucketCorsInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定Cors规则 CorsRules: [ { // 指定允许的跨域请求方法(GET/PUT/DELETE/POST/HEAD) AllowedMethod: ['GET', 'HEAD', 'PUT'], // 指定允许跨域请求的来源 AllowedOrigin: ['http://www.a.com', 'http://www.b.com'], // 控制在OPTIONS预取指令中Access-Control-Request-Headers头中指定的header是否被允许使用 AllowedHeader: ['x-obs-header'], // 指定允许用户从应用程序中访问的header ExposeHeader: ['x-obs-expose-header'], // 指定浏览器对特定资源的预取(OPTIONS)请求返回结果的缓存时间,单位为秒 MaxAgeSeconds: 10 } ] }; // 设置桶的CORS配置 const result = await obsClient.setBucketCors(params); if (result.CommonMsg.Status <= 300) { console.log("Set bucket(%s) CORS configuration successful!", params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); return; } console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response."); console.log("Status: %d", result.CommonMsg.Status); console.log("Code: %s", result.CommonMsg.Code); console.log("Message: %s", result.CommonMsg.Message); console.log("RequestId: %s", result.CommonMsg.RequestId); } catch (error) { console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network."); console.log(error); } } setBucketCors(); |
相关链接
- 关于设置桶的CORS配置的API说明,请参见设置桶的CORS配置。
- 设置桶的CORS配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。