文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 设置桶的CORS配置(Python SDK)
更新时间：2024-11-26 GMT+08:00
查看PDF
分享

设置桶的CORS配置(Python 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的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.setBucketCors(bucketName, corsRuleList, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

corsRuleList

list of CorsRule

必选

参数解释：

桶的CORS规则列表，详见CorsRule。

约束限制：

列表最多包含100个规则。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表1 CorsRule

参数名称

参数类型

是否必选

描述

id

str

作为请求参数时可选

参数解释：

CORS规则ID。

取值范围：

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

默认取值：

无

allowedMethod

list of str

作为请求参数时必选

参数解释：

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

取值范围：

支持以下HTTP方法：

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE

默认取值：

无

allowedOrigin

list of str

作为请求参数时必选

参数解释：

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

约束限制：

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

默认取值：

无

allowedHeader

list of str

作为请求参数时可选

参数解释：

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

约束限制：

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

默认取值：

无

maxAgeSecond

int

或

str

作为请求参数时可选

参数解释：

请求来源的客户端可以对跨域请求返回结果的缓存时间。

约束限制：

每个CORSRule可以包含至多一个maxAgeSecond。

取值范围：

大于等于0的整型数，单位：秒。

默认取值：

100

exposeHeader

list of str

作为请求参数时可选

参数解释：

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

约束限制：

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

默认取值：

无

返回结果说明

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表2 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

代码样例

本示例用于设置名为examplebucket的桶跨域资源共享规则。

 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
 
from obs import ObsClient
from obs import CorsRule
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以中国-香港为例，其他地区请按实际情况填写
server = "https://obs.ap-southeast-1.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    # 指定Cors规则
    cors1 = CorsRule(id='rule1', allowedMethod=['PUT', 'POST', 'GET', 'DELETE', 'HEAD'],
                     allowedOrigin=['obs.hostname', 'obs.hostname1'], allowedHeader=['obs-header-1'],
                     maxAgeSecond=60)
    cors2 = CorsRule(id='rule2', allowedMethod=['PUT', 'POST', 'GET'],
                     allowedOrigin=['obs.hostname', 'obs.hostname1'], allowedHeader=['header-1', 'header-2'],
                     maxAgeSecond=50, exposeHeader=['head1'])
    corsList = [cors1, cors2]
    bucketName = "examplebucket"
    # 设置桶的CORS配置
    resp = obsClient.setBucketCors(bucketName, corsList)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Set Bucket Cors Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Bucket Cors Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Set Bucket Cors Failed')
    print(traceback.format_exc())

相关链接

  • 关于设置桶的CORS配置的API说明，请参见设置桶的CORS配置。
  • 更多关于设置桶的CORS配置的示例代码，请参见Github示例。
  • 设置桶的CORS配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。