如何通过Python SDK V2实现跨域资源共享_对象存储(OSS)-阿里云帮助中心

因浏览器的同源策略限制，在不同域名之间进行数据交互或者资源共享时，会出现跨域请求被拒绝的问题。本文介绍如何通过设置允许特定的域名、方法和请求头的跨域访问策略，解决跨域问题。

注意事项

本文示例代码以华东1（杭州）的地域IDcn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要设置跨域规则，您必须有oss:PutBucketCors权限；要获取跨域规则，您必须有oss:GetBucketCors权限；要删除跨域规则，您必须有oss:DeleteBucketCors权限。具体操作，请参见为RAM用户授予自定义的权限策略。

方法定义

设置跨域资源共享规则

put_bucket_cors(request: PutBucketCorsRequest, **kwargs) → PutBucketCorsResult

获取跨域资源共享规则

get_bucket_cors(request: GetBucketCorsRequest, **kwargs) → GetBucketCorsResult

删除跨域资源共享规则

delete_bucket_cors(request: DeleteBucketCorsRequest, **kwargs) → DeleteBucketCorsResult

请求参数列表

参数名	类型	说明
request	PutBucketCorsRequest	设置请求参数，具体请参见PutBucketCorsRequest
	GetBucketCorsRequest	设置请求参数，具体请参见GetBucketCorsRequest
	DeleteBucketCorsRequest	设置请求参数，具体请参见DeleteBucketCorsRequest

返回值列表

类型	说明
PutBucketCorsResult	返回值，具体请参见PutBucketCorsResult
GetBucketCorsResult	返回值，具体请参见GetBucketCorsResult
DeleteBucketCorsResult	返回值，具体请参见DeleteBucketCorsResult

关于设置跨域资源共享规则的完整定义，请参见put_bucket_cors。

关于获取跨域资源共享规则的完整定义，请参见get_bucket_cors。

关于删除跨域资源共享规则的完整定义，请参见delete_bucket_cors。

示例代码

设置跨域资源共享规则

您可以使用以下代码设置指定存储空间的跨域规则。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：设置存储空间（Bucket）的CORS配置
parser = argparse.ArgumentParser(description="put bucket cors sample")

# 定义命令行参数，包括必需的区域、存储空间名称以及可选的endpoint和response_vary
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--response_vary', help='Indicates whether the Vary: Origin header was returned. Default value: false', default='false')

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以设置指定存储空间的CORS配置
    result = client.put_bucket_cors(oss.PutBucketCorsRequest(
            bucket=args.bucket,  # 存储空间名
            cors_configuration=oss.CORSConfiguration(
                cors_rules=[
                    # 第一条CORS规则
                    oss.CORSRule(
                        allowed_origins=['*'],  # 允许所有来源
                        allowed_methods=['GET', 'HEAD'],  # 允许的方法
                        allowed_headers=['GET'],  # 允许的请求头
                        expose_headers=['x-oss-test', 'x-oss-test1'],  # 暴露的响应头
                        max_age_seconds=33012,  # 预检请求的有效期
                    ),
                    # 第二条CORS规则
                    oss.CORSRule(
                        allowed_origins=['http://www.example.com'],  # 允许特定来源
                        allowed_methods=['PUT', 'POST'],  # 允许的方法
                        allowed_headers=['*'],  # 允许所有请求头
                        expose_headers=['x-oss-test2', 'x-oss-test3'],  # 暴露的响应头
                        max_age_seconds=33012,  # 预检请求的有效期
                    )
                ],
                response_vary=args.response_vary,  # 是否返回Vary: Origin头，默认为False
            ),
    ))

    # 打印操作结果的状态码和请求ID，以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

获取跨域资源共享规则

您可以使用以下代码获取跨域规则。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：获取存储空间（Bucket）的CORS配置
parser = argparse.ArgumentParser(description="get bucket cors sample")

# 定义命令行参数，包括必需的区域、存储空间名称以及可选的endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以获取指定存储空间的CORS配置
    result = client.get_bucket_cors(oss.GetBucketCorsRequest(
            bucket=args.bucket,  # 存储空间名
    ))

    # 打印操作结果的状态码、请求ID和response vary值
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' response vary: {result.cors_configuration.response_vary},'
          )

    # 遍历并打印每个CORS规则的详细信息
    for r in result.cors_configuration.cors_rules:
        print(f'result: {r.max_age_seconds}, {r.allowed_origins}, {r.allowed_methods}, {r.allowed_headers}, {r.expose_headers}')

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

删除跨域资源共享规则

您可以使用以下代码删除指定存储空间的所有跨域规则。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：删除存储空间（Bucket）的CORS配置
parser = argparse.ArgumentParser(description="delete bucket cors sample")

# 定义命令行参数，包括必需的区域、存储空间名称以及可选的endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以删除指定存储空间的CORS配置
    result = client.delete_bucket_cors(oss.DeleteBucketCorsRequest(
            bucket=args.bucket,  # 存储空间名
    ))

    # 打印操作结果的状态码和请求ID，以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

跨域资源共享（Python SDK V2）

注意事项

方法定义

设置跨域资源共享规则

获取跨域资源共享规则

删除跨域资源共享规则

请求参数列表

返回值列表

示例代码

设置跨域资源共享规则

获取跨域资源共享规则

删除跨域资源共享规则

相关文档