设置桶的CORS配置(Go 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的对应关系,详细信息请参见地区与终端节点。
方法定义
func (obsClient ObsClient) SetBucketCors(input *SetBucketCorsInput, extensions...extensionOptions) (output *BaseModel, err error)
请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
input |
必选 |
参数解释: 设置桶的CORS配置请求参数,详见SetBucketCorsInput。 |
|
extensions |
可选 |
参数解释: 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头,详情参考extensionOptions。 |
参数 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
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 |
int |
作为请求参数时可选 |
参数解释: 请求来源的客户端可以对跨域请求返回结果的缓存时间。 约束限制: 每个CORSRule可以包含至多一个MaxAgeSeconds。 取值范围: 0~(231-1),单位:秒。 默认取值: 100 |
ExposeHeader |
[]string |
作为请求参数时可选 |
参数解释: CORS规则允许响应中可返回的附加头域,给客户端提供额外的信息。默认情况下浏览器只能访问以下头域:Content-Length、Content-Type,如果需要访问其他头域,需要在附加头域中配置。 约束限制: 不支持*、&、:、<、空格以及中文字符。 默认取值: 无 |
返回结果说明
参数名称 |
参数类型 |
描述 |
---|---|---|
StatusCode |
int |
参数解释: HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值: 无 |
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 默认取值: 无 |
ResponseHeaders |
map[string][]string |
参数解释: HTTP响应头信息。 默认取值: 无 |
代码示例
本示例用于配置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 |
package main import ( "fmt" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak := os.Getenv("AccessKeyID") sk := os.Getenv("SecretAccessKey") // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。 securityToken := os.Getenv("SecurityToken") // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。 endPoint := "https://obs.cn-north-4.myhuaweicloud.com" // 创建obsClient实例 // 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。 obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken)) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } input := &obs.SetBucketCorsInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定Cors规则 input.CorsRules = []obs.CorsRule{ { ID: "rule1", AllowedOrigin: []string{"http://www.a.com", "http://www.b.com"}, AllowedMethod: []string{"GET", "PUT"}, AllowedHeader: []string{"header1", "header2"}, MaxAgeSeconds: 1000, ExposeHeader: []string{"obs-1", "obs-2"}, }, { ID: "rule2", AllowedOrigin: []string{"http://www.c.com", "http://www.d.com"}, AllowedMethod: []string{"GET", "POST"}, AllowedHeader: []string{"header3", "header4"}, MaxAgeSeconds: 1000, }, } // 设置桶的CORS配置 output, err := obsClient.SetBucketCors(input) if err == nil { fmt.Printf("Set bucket(%s) CORS configuration successful!\n", input.Bucket) fmt.Printf("RequestId:%s\n", output.RequestId) return } fmt.Printf("Set bucket(%s) CORS configuration fail!\n", input.Bucket) if obsError, ok := err.(obs.ObsError); ok { fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.") fmt.Println(obsError.Error()) } else { fmt.Println("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.") fmt.Println(err) } } |
相关链接
- 关于设置桶的CORS配置的API说明,请参见设置桶的CORS配置。
- 更多关于设置桶的CORS配置的示例代码,请参见Github示例。
- 设置桶的CORS配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。