如何通過Python SDK V2實現跨域資源共用 - Object Storage Service

因瀏覽器的同源策略限制，在不同網域名稱之間進行資料互動或者資源共用時，會出現跨域請求被拒絕的問題。本文介紹如何通過設定允許特定的網域名稱、方法和要求標頭的跨域存取原則，解決跨域問題。

注意事項

本文範例程式碼以華東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()  # 指令碼進入點，控製程序流程從這裡開始

Object Storage Service：跨域資源共用（Python SDK V2）

注意事項

方法定義

設定跨域資源共用規則

擷取跨域資源共用規則

刪除跨域資源共用規則

請求參數列表

傳回值列表

範例程式碼

設定跨域資源共用規則

擷取跨域資源共用規則

刪除跨域資源共用規則

相關文檔