使用Python SDK V2配置Referer防盜鏈來阻止其他網站引用OSS檔案 - Object Storage Service

您可以使用阿里雲OSS的Python SDK來配置基於請求標題Referer的訪問規則，包括設定白名單Referer、黑名單Referer以及是否允許空Referer。通過這些配置，您可以阻止特定Referer訪問您的OSS檔案，防止其他網站盜用您的資源，從而避免不必要的流量費用增加。

注意事項

在配置防盜鏈之前，請確保您已瞭解該功能。詳情請參見防盜鏈。
本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。
要設定或清空防盜鏈，您必須具有oss:PutBucketReferer許可權；要擷取防盜鏈，您必須具有oss:GetBucketReferer許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

方法定義

設定防盜鏈

put_bucket_referer(request: PutBucketRefererRequest, **kwargs) → PutBucketRefererResult

擷取防盜鏈設定

get_bucket_referer(request: GetBucketRefererRequest, **kwargs) → GetBucketRefererResult

請求參數列表

參數名	類型	說明
request	PutBucketRefererRequest	佈建要求參數，具體請參見PutBucketRefererRequest
request	GetBucketRefererRequest	佈建要求參數，具體請參見GetBucketRefererRequest

傳回值列表

類型	說明
PutBucketRefererResult	傳回值，具體請參見PutBucketRefererResult
GetBucketRefererResult	傳回值，具體請參見GetBucketRefererResult

關於設定防盜鏈方法的完整定義，請參見put_bucket_referer。

關於擷取防盜鏈設定方法的完整定義，請參見get_bucket_referer。

範例程式碼

設定防盜鏈

您可以使用以下代碼設定防盜鏈。

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：設定儲存空間（Bucket）的防盜鏈配置
parser = argparse.ArgumentParser(description="put bucket referer 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)

    # 發送請求以設定指定儲存空間的防盜鏈配置
    result = client.put_bucket_referer(oss.PutBucketRefererRequest(
            bucket=args.bucket,  # 儲存空間名
            referer_configuration=oss.RefererConfiguration(
                allow_empty_referer=True,  # 是否允許空Referer，預設為True
                allow_truncate_query_string=False,  # 是否允許截斷查詢字串，預設為False
                truncate_path=False,  # 是否截斷路徑，預設為False
                referer_list=oss.RefererList(
                    referers=['http://www.aliyun.com', 'https://www.aliyun.com'],  # 允許的Referer列表
                ),
                referer_blacklist=oss.RefererBlacklist(
                    referers=['http://www.refuse.com', 'http://www.refuse1.com'],  # 拒絕的Referer黑名單
                ),
            ),
    ))

    # 列印操作結果的狀態代碼和請求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）的防盜鏈配置
parser = argparse.ArgumentParser(description="get bucket referer 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)

    # 發送請求以擷取指定儲存空間的防盜鏈配置
    result = client.get_bucket_referer(oss.GetBucketRefererRequest(
            bucket=args.bucket,  # 儲存空間名
    ))

    # 列印操作結果的狀態代碼、請求ID和防盜鏈配置詳情，以便確認請求狀態和配置詳情
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' allow empty referer: {getattr(result.referer_configuration, "allow_empty_referer", "Not set")},'
          f' allow truncate query string: {getattr(result.referer_configuration, "allow_truncate_query_string", "Not set")},'
          f' truncate path: {getattr(result.referer_configuration, "truncate_path", "Not set")},'
          f' referer list: {getattr(result.referer_configuration, "referer_list", "Not set")},'
          f' referer blacklist: {getattr(result.referer_configuration, "referer_blacklist", "Not set")},'
          )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

Object Storage Service：防盜鏈（Python SDK V2）

注意事項

方法定義

設定防盜鏈

擷取防盜鏈設定

請求參數列表

傳回值列表

範例程式碼

設定防盜鏈

擷取防盜鏈設定

相關文檔