すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:ホットリンク保護 (Python SDK V2)

最終更新日:Nov 09, 2025

Alibaba Cloud OSS SDK for Python を使用して、Referer リクエストヘッダーに基づいてアクセスルールを構成できます。たとえば、Referer ホワイトリスト、Referer ブラックリストの設定、空の Referer ヘッダーを許可するかどうかの指定などです。これらの構成により、特定の Referer ヘッダーによる OSS ファイルへのアクセスをブロックし、リソースの不正使用を防ぎ、不要なトラフィックコストを回避できます。

前提条件

  • ホットリンク保護を構成する前に、この機能を理解していることを確認してください。詳細については、「ホットリンク保護」をご参照ください。

  • このトピックのサンプルコードでは、中国 (杭州) リージョン (ID: cn-hangzhou) を例として使用します。デフォルトでは、パブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS リージョンとそれに対応するエンドポイントの詳細については、「OSS リージョンとエンドポイント」をご参照ください。

  • ホットリンク保護構成を設定または削除するには、oss:PutBucketReferer 権限が必要です。ホットリンク保護構成を取得するには、oss:GetBucketReferer 権限が必要です。詳細については、「RAM ユーザーにカスタム権限を付与する」をご参照ください。

メソッド定義

ホットリンク保護の設定

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

ホットリンク保護設定の取得

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

リクエストパラメーター

パラメーター

タイプ

説明

request

PutBucketRefererRequest

リクエストパラメーター。詳細については、「PutBucketRefererRequest」をご参照ください。

GetBucketRefererRequest

リクエストパラメーター。詳細については、「GetBucketRefererRequest」をご参照ください。

戻り値

タイプ

説明

PutBucketRefererResult

戻り値。詳細については、「PutBucketRefererResult」をご参照ください。

GetBucketRefererResult

戻り値。詳細については、「GetBucketRefererResult」をご参照ください。

ホットリンク保護を設定するメソッドの完全な定義については、「put_bucket_referer」をご参照ください。

ホットリンク保護設定を取得するメソッドの完全な定義については、「get_bucket_referer」をご参照ください。

ホットリンク保護の設定

次のコードを使用して、ホットリンク保護を設定できます。

import argparse
import alibabacloud_oss_v2 as oss

# コマンドライン引数パーサーを作成し、スクリプトの目的を記述します: バケットのホットリンク保護を構成します。
parser = argparse.ArgumentParser(description="put bucket referer sample")

# 必須のリージョン、バケット名、オプションのエンドポイントなど、コマンドライン引数を定義します。
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()

    # ID 検証のために、環境変数からアクセス資格情報を読み込みます。
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # デフォルトの SDK 構成を使用して構成オブジェクトを作成し、認証プロバイダーを設定します。
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # ユーザーが指定したコマンドライン引数に基づいて、構成オブジェクトのリージョンプロパティを設定します。
    cfg.region = args.region

    # カスタムエンドポイントが指定されている場合は、構成オブジェクトのエンドポイントプロパティを更新します。
    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

# コマンドライン引数パーサーを作成し、スクリプトの目的を記述します: バケットのホットリンク保護構成を取得します。
parser = argparse.ArgumentParser(description="get bucket referer sample")

# 必須のリージョン、バケット名、オプションのエンドポイントなど、コマンドライン引数を定義します。
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()

    # ID 検証のために、環境変数からアクセス資格情報を読み込みます。
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # デフォルトの SDK 構成を使用して構成オブジェクトを作成し、認証プロバイダーを設定します。
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    
    # ユーザーが指定したコマンドライン引数に基づいて、構成オブジェクトのリージョンプロパティを設定します。
    cfg.region = args.region

    # カスタムエンドポイントが指定されている場合は、構成オブジェクトのエンドポイントプロパティを更新します。
    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()  # スクリプトのエントリポイント。ここからプログラムのフローが開始されます。

関連ドキュメント

  • ホットリンク保護を構成するときに発生する一般的なエラーのトラブルシューティング方法については、「33-REFERER」をご参照ください。

  • ホットリンク保護を設定するための完全なサンプルコードについては、「put_bucket_referer.py」をご参照ください。

  • ホットリンク保護構成を取得するための完全なサンプルコードについては、「get_bucket_referer.py」をご参照ください。