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

Object Storage Service:OSS Python SDK V1

最終更新日:Oct 23, 2026

OSS Python SDK V2 のご利用を推奨します。OSS Python SDK V2 は、認証、リトライ、エラー処理を再設計し、ページネーター、転送マネージャー、ファイルライクインターフェイスを追加しています。

クイックスタート

次の手順で OSS Python SDK V1 の利用を開始します。

環境の準備

Python のインストール

OSS Python SDK V1 は、Python 2.6、2.7、3.3、3.4、3.5、3.6、3.7、3.8 以降と互換性があります。

Windows 環境に Python SDK をインストールする場合、Visual C++ のバージョンが 15.0 以降であることを確認してください。

python-devel のインストール

OSS Python SDK V1 は、CRC チェックサムに crcmod ライブラリを使用します。その C 拡張には、python-devel の Python.h ヘッダーが必要です。これがない場合、SDK は純粋な Python の CRC 検証にフォールバックしますが、アップロードとダウンロードの速度が大幅に低下します。

Windows

Windows では、必要なヘッダーファイルはデフォルトの Python インストールに含まれています。別途 python-devel をインストールする必要はありません。

macOS

macOS では、必要なヘッダーファイルはデフォルトの Python インストールに含まれています。別途 python-devel をインストールする必要はありません。

CentOS

python-devel をインストールするには、次のコマンドを実行します。

yum install python-devel

RHEL

python-devel をインストールするには、次のコマンドを実行します。

yum install python-devel

Fedora

python-devel をインストールするには、次のコマンドを実行します。

yum install python-devel

Debian

python-devel をインストールするには、次のコマンドを実行します。

apt-get install python-dev

Ubuntu

python-devel をインストールするには、次のコマンドを実行します。

apt-get install python-dev

SDK のインストール

次のいずれかの方法で SDK をインストールします。コード例との互換性を確保するため、最新バージョンを使用してください。

pip でのインストール

  1. pip をインストールします。pip は Python 2.7.9 以降、または Python 3.4 以降にデフォルトでインストールされています。

  2. 最新の SDK バージョンをインストールするには、次のコマンドを実行します。

    pip install oss2                   

ソースからのインストール

  1. GitHub から最新バージョンの SDK をダウンロードし、パッケージを解凍してから、ディレクトリに移動します。ディレクトリに setup.py ファイルが含まれていることを確認してください。

    以前のバージョンの OSS Python SDK V1 をダウンロードするには、「リリース履歴」をご参照ください。

  2. SDK をインストールするには、次のコマンドを実行します。

    python setup.py install                   

アクセス認証情報の設定

RAM ユーザーの AccessKey ペアでアクセス認証情報を設定します。

  1. RAM コンソールで、[永続的な AccessKey ペア] を持つ RAM ユーザーを作成します。AccessKey ペアを保存し、ユーザーに AliyunOSSFullAccess 権限を付与します。

  2. RAM ユーザーの AccessKey ペアを使用して環境変数を設定します。

    Linux

    1. コマンドラインインターフェイスで次のコマンドを実行して、環境変数の設定を ~/.bashrc ファイルに追加します。

      echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
      echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc
    2. 次のコマンドを実行して変更を適用します。

      source ~/.bashrc
    3. 次のコマンドを実行して、環境変数が設定されていることを確認します。

      echo $OSS_ACCESS_KEY_ID
      echo $OSS_ACCESS_KEY_SECRET

    macOS

    1. ターミナルで次のコマンドを実行して、デフォルトのシェルタイプを表示します。

      echo $SHELL
    2. デフォルトのシェルタイプに基づいて、次の操作を実行します。

      Zsh
      1. 次のコマンドを実行して、環境変数の設定を ~/.zshrc ファイルに追加します。

        echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
        echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc
      2. 次のコマンドを実行して変更を適用します。

        source ~/.zshrc
      3. 次のコマンドを実行して、環境変数が設定されていることを確認します。

        echo $OSS_ACCESS_KEY_ID
        echo $OSS_ACCESS_KEY_SECRET
      Bash
      1. 次のコマンドを実行して、環境変数の設定を ~/.bash_profile ファイルに追加します。

        echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
        echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile
      2. 次のコマンドを実行して変更を適用します。

        source ~/.bash_profile
      3. 次のコマンドを実行して、環境変数が設定されていることを確認します。

        echo $OSS_ACCESS_KEY_ID
        echo $OSS_ACCESS_KEY_SECRET

    Windows

    CMD
    1. CMD で次のコマンドを実行します。

      setx OSS_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
      setx OSS_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"
    2. 次のコマンドを実行して、環境変数が設定されていることを確認します。

      echo %OSS_ACCESS_KEY_ID%
      echo %OSS_ACCESS_KEY_SECRET%
    PowerShell
    1. PowerShell で次のコマンドを実行します。

      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)
    2. 次のコマンドを実行して、環境変数が設定されていることを確認します。

      [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
      [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

クライアントの初期化

OSS Python SDK V1 でのほとんどの操作では、oss2.Service クラスと oss2.Bucket クラスを使用します。

  • oss2.Service クラスはバケットを一覧表示します。カスタムドメイン名によるアクセスはサポートしていません。

  • oss2.Bucket クラスは、ファイルのアップロード、ダウンロード、削除、およびさまざまなバケット設定を行います。

重要

コンプライアンスとセキュリティを向上させるためのポリシーの変更により、2025 年 3 月 20 日以降、新しい OSS ユーザーは、中国本土リージョンにある OSS バケットでデータ API オペレーションを実行するために、カスタムドメイン名 (CNAME) を使用する必要があります。これらの操作では、デフォルトのパブリックエンドポイントは制限されます。影響を受ける操作の完全なリストについては、公式発表をご参照ください。HTTPS 経由でデータにアクセスする場合、カスタムドメインに有効な SSL 証明書をバインドする必要があります。これは、コンソールが HTTPS を適用するため、OSS コンソールへのアクセスには必須です。

バケットインスタンスの初期化

サンプルコードを実行する前に、<region-id> などのプレースホルダーを、実際の リージョンとエンドポイント (例: ap-southeast-1) に置き換えてください。
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# OSS Python SDK V1 でクライアントを初期化するサンプルコード

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

def main():

    # 環境変数からアクセス認証情報を読み込みます。OSS_ACCESS_KEY_ID と OSS_ACCESS_KEY_SECRET の環境変数を設定する必要があります。
    auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
    # OSS サービスリージョンを設定します。
    region = "<region-id>"
    # エンドポイントを設定します。
    endpoint = "<endpoint>"
    # バケット名を設定します。
    bucket_name = "example-bucket"

    # OSS バケットインスタンスを初期化します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # バケット内のファイルを一覧表示します。
    print("=== List files in the bucket ===")
    try:
        # list_objects メソッドを使用してファイルを一覧表示します。
        result = bucket.list_objects()
        
        # ファイルリストを反復処理し、ファイル名のみを出力します。
        for obj in result.object_list:
            print(obj.key)
        
        # 統計情報を出力します。
        print(f"\nTotal files listed: {len(result.object_list)}")
        if result.is_truncated:
            print("Note: The result is truncated. More files are available.")
            
    except oss2.exceptions.OssError as e:
        print(f"OSS error: {e}")
        raise
    except Exception as e:
        print(f"An error occurred: {e}")
        raise

if __name__ == "__main__":
    # プログラムのエントリポイント。
    try:
        main()
    except Exception as e:
        print(f"An error occurred during execution: {e}")
        raise

サービスインスタンスの初期化

サンプルコードを実行する前に、<region-id> などのプレースホルダーを、実際の リージョンとエンドポイント (たとえば ap-southeast-1 など) に置き換えてください。
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# OSS Python SDK V1 でサービスインスタンスを初期化するサンプルコード

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

def main():

    # 環境変数からアクセス認証情報を読み込みます。OSS_ACCESS_KEY_ID と OSS_ACCESS_KEY_SECRET の環境変数を設定する必要があります。
    auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
    # OSS サービスリージョンを設定します。
    region = "<region-id>"
    # エンドポイントを設定します。
    endpoint = "<endpoint>"

    # OSS サービスインスタンスを初期化します。
    service = oss2.Service(auth, endpoint, region=region)
    
    # すべてのバケットを一覧表示します。
    print("=== List all buckets ===")
    try:
        # BucketIterator を使用してバケットを一覧表示します。
        buckets = [b.name for b in oss2.BucketIterator(service)]
        
        # バケットリストを反復処理し、バケット名のみを出力します。
        for bucket in buckets:
            print(bucket)
        
        # 統計情報を出力します。
        print(f"\nTotal buckets listed: {len(buckets)}")
            
    except oss2.exceptions.OssError as e:
        print(f"OSS error: {e}")
        raise
    except Exception as e:
        print(f"An error occurred: {e}")
        raise

if __name__ == "__main__":
    # プログラムのエントリポイント。
    try:
        main()
    except Exception as e:
        print(f"An error occurred during execution: {e}")
        raise

クライアント設定

OSS クライアントを初期化する際に、エンドポイント、タイムアウト、接続プールサイズなどのパラメーターをカスタマイズします。

内部ドメイン名の使用

内部ネットワーク経由で OSS にアクセスするには、内部ドメイン名をエンドポイントとして使用します。

コード内の <region-id> プレースホルダーを、ap-southeast-1 などの実際の リージョン
endpoint = "oss-<region-id>-internal.aliyuncs.com"

# OSS バケットインスタンスを初期化します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)

カスタムドメイン名の使用

カスタムドメイン名を使用するには、エンドポイントをドメインに設定し、is_cname=True を有効にします。

使用する前に、カスタムドメイン名をバケットにマッピングしてください。「カスタムドメイン名を使用した OSS へのアクセス」をご参照ください。
# カスタムドメイン名を設定します。
endpoint = "http://example.com"

# OSS バケットインスタンスを初期化します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, is_cname=True, region=region)

タイムアウト制御

クライアントを初期化する際に、connect_timeout パラメーター (秒単位) を設定します。デフォルト:60 秒。

# OSS バケットインスタンスを初期化します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, connect_timeout=30, region=region)

接続プールサイズ

session オブジェクトの pool_size パラメーターで接続プールサイズを調整します。

# 接続プールサイズを設定します。デフォルト値は 10 です。
session = oss2.Session(pool_size=20)

# OSS バケットインスタンスを初期化します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, session=session, region=region)

TLS バージョン

TLS バージョンを指定するには、カスタム SSLAdapter を使用してセッションを作成します。

Python SDK 2.18.1 以降のバージョンでは、TLS バージョンを指定できます。
import ssl
from requests.adapters import HTTPAdapter

# TLS バージョンを指定するためのカスタムアダプターを定義します。
class SSLAdapter(HTTPAdapter):
    def init_poolmanager(self, *args, **http_client_config):
        # TLS 1.2 を指定します。
        http_client_config["ssl_version"] = ssl.PROTOCOL_TLSv1_2
        return super(SSLAdapter, self).init_poolmanager(*args, **http_client_config)
        
# SSLAdapter を使用してセッションを作成します。
session = oss2.Session(adapter=SSLAdapter())

# OSS バケットインスタンスを初期化します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, session=session, region=region)

CRC チェックの無効化

CRC データ整合性チェックを無効にするには、enable_crc=False パラメーターを設定します。

重要

CRC は有効にしておくことを推奨します。無効にすると、OSS はアップロードおよびダウンロード中のデータ整合性を保証できません。

# OSS バケットインスタンスを初期化します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, enable_crc=False, region=region)

署名バージョン

重要

Alibaba Cloud Object Storage V1 署名は、以下のスケジュールに従って廃止されます。サービスに影響が出ないよう、できるだけ早くV4 署名にアップグレードすることを推奨します。

  • 2025 年 3 月 1 日以降、新規ユーザーは V1 署名を使用できなくなります。

  • 2025 年 9 月 1 日以降、V1 署名のサポートとメンテナンスを段階的に廃止し、V1 署名を使用する新しいバケットを作成できなくなります。

次の例では、V1 署名でクライアントを初期化します。V4 署名の初期化については、「クライアントの初期化」をご参照ください。

サンプルコードを実行する前に、<endpoint> などのプレースホルダーを、https://oss-ap-southeast-1.aliyuncs.com のような実際の リージョンとエンドポイント
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# OSS Python SDK V1 クライアント初期化サンプルコード
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

def main():

    # 環境変数からアクセス認証情報を読み込みます。OSS_ACCESS_KEY_ID と OSS_ACCESS_KEY_SECRET の環境変数を設定する必要があります。
    auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())

    # エンドポイントを設定します。
    endpoint = "<endpoint>"
    # バケット名を設定します。
    bucket_name = "example-bucket"

    # OSS バケットインスタンスを初期化します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name)
    
    # バケット内のファイルを一覧表示します。
    print("=== List files in the bucket ===")
    try:
        # list_objects() メソッドを使用してファイルを一覧表示します。
        result = bucket.list_objects()
        
        # オブジェクトリストを反復処理し、各オブジェクトのキーを出力します。
        for obj in result.object_list:
            print(obj.key)
        
        # 統計情報を出力します。
        print(f"\nTotal files listed: {len(result.object_list)}")
        if result.is_truncated:
            print("Note: The result is truncated. More files are available.")
            
    except oss2.exceptions.OssError as e:
        print(f"OSS error: {e}")
        raise
    except Exception as e:
        print(f"An error occurred: {e}")
        raise

if __name__ == "__main__":
    # プログラムのエントリポイント。
    try:
        main()
    except Exception as e:
        print(f"An error occurred while running the program: {e}")
        raise

カスタムアプリケーション名

app_name パラメーターを設定して、User-Agent ヘッダーにカスタム識別子を追加します。デフォルト:空の文字列。

アプリケーション名は HTTP ヘッダー値として送信されるため、HTTP 標準に準拠する必要があります。
# OSS バケットインスタンスを初期化します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, app_name="client_test", region=region)

サンプルコード

OSS Python SDK V1 は、バケット管理、オブジェクト操作、アクセス制御、暗号化転送のコードサンプルを提供しています。これらをリファレンスとして使用したり、アプリケーションに統合したりできます。

GitHub サンプルコード

ドキュメントサンプルコード

bucket.py

bucket_cname.py

カスタムドメイン名のマッピング (Python SDK V1)

bucket_cors.py

オリジン間リソース共有 (CORS) (Python SDK V1)

bucket_inventory.py

インベントリ (Python SDK V1)

bucket_logging.py

ログ記録 (Python SDK V1)

bucket_meta_query.py

バケットメタデータのクエリ (Python SDK V1)

bucket_policy.py

ポリシー

bucket_referer.py

ホットリンク保護 (Python SDK V1)

bucket_replication.py

レプリケーション (Python SDK V1)

bucket_symlink.py

シンボリックリンクの管理 (Python SDK V1)

bucket_tagging.py

バケットのタグ付け (Python SDK V1)

bucket_transfer_acceleration.py

転送アクセラレーション (Python SDK V1)

bucket_versioning.py

バージョン管理の管理 (Python SDK V1)

bucket_website.py

静的ウェブサイトのホスティング

bucket_worm.py

保持ポリシー

download.py

image.py

画像処理 (Python SDK V1)

object_basic.py

object_callback.py

アップロードコールバック (Python SDK V1)

object_check.py

データ整合性チェック (Python SDK V1)

object_crypto.py

クライアントサイド暗号化 (Python SDK V1)

object_extra.py

ユーザー定義メタデータの設定

object_forbid_overwrite.py

オブジェクトの上書き防止 (Python SDK V1)

object_operation.py

object_post.py

Post アップロード

object_progress.py

object_request_payment.py

リクエスタ支払い (Python SDK V1)

object_restore.py

オブジェクトの復元 (Python SDK V1)

server_side_encryption.py

サーバーサイド暗号化 (Python SDK V1)

object_storage_type.py

オブジェクトのストレージクラスの変更 (Python SDK V1)

sts.py

STS トークンによるアクセス (Python SDK V1)

object_tagging.py

select_csv.py

オブジェクトのクエリ (Python SDK V1)

traffic_limit.py

接続の転送レート制限 (Python SDK V1)

upload.py

エンドポイント情報のクエリ

利用可能なすべてのリージョンまたは特定のリージョンのエンドポイント情報 (パブリック (IPv4)、内部、転送アクセラレーションエンドポイントを含む) をクエリします。

説明

Python SDK 2.18.0 以降は、エンドポイント情報のクエリをサポートしています。

サンプルコードを実行する前に、<region-id> などのプレースホルダーを、実際の リージョンとエンドポイント (ap-southeast-1 など) に置き換えてください。
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# OSS Python SDK を使用してエンドポイント情報をクエリするサンプルコード

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

def main():

    print("=== Querying endpoint information for all supported regions ===\n")
    
    # 環境変数からアクセス認証情報を取得します。OSS_ACCESS_KEY_ID と OSS_ACCESS_KEY_SECRET の環境変数を設定する必要があります。
    auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
    
    # バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = "<endpoint>"
    
    # エンドポイントに対応するリージョンを指定します。このパラメーターは、署名 V4 を使用する場合に必須です。
    region = "<region-id>"
    
    # OSS サービスインスタンスを初期化します。
    service = oss2.Service(auth, endpoint, region=region)
    
    try:
        # サポートされているすべてのリージョンのエンドポイント情報をクエリします。
        result = service.describe_regions()
        
        # リージョン情報を反復処理します。
        for r in result.regions:
            print(f"Region: {r.region}")
            print(f"  Public (IPv4) Endpoint: {r.internet_endpoint}")
            print(f"  Internal (Classic Network or VPC) Endpoint: {r.internal_endpoint}")
            print(f"  Transfer Acceleration Endpoint: {r.accelerate_endpoint}")
            print("-" * 80)
        
        # 統計情報を出力します。
        print(f"\nFound endpoint information for {len(result.regions)} regions.")
            
    except oss2.exceptions.OssError as e:
        print(f"OSS error: {e}")
        raise
    except Exception as e:
        print(f"An error occurred: {e}")
        raise

if __name__ == "__main__":
    # プログラムのエントリポイント。
    try:
        main()
    except Exception as e:
        print(f"An error occurred during execution: {e}")
        raise

特定のリージョンのエンドポイント情報をクエリするには、describe_regions メソッドで OSS 固有のリージョン ID を指定します。

result = service.describe_regions("oss-<region-id>")

認証情報の設定

OSS は複数の認証情報初期化方法をサポートしています。認証要件に基づいていずれかを選択してください。

alibabacloud-credentials のバージョン 0.3.5 以降を使用する必要があります。それ以前のバージョンを使用するとエラーが発生します。

認証情報タイプの選択

初期化方法

利用シーン

事前設定

認証情報タイプ

有効性

ローテーションまたはリフレッシュ

RAM ユーザーの Access Key (AK) の使用

頻繁な認証情報のローテーションなしでクラウドサービスへの長期アクセスが必要な、安全な環境のアプリケーション向け。

はい

Access Key (AK)

長期

手動ローテーション

Security Token Service (STS) からの一時的なアクセス認証情報の使用

有効期間が限定され、特定の権限を持つ認証情報が必要な、信頼できない環境のアプリケーション向け。

はい

STS トークン

一時的

手動リフレッシュ

RAM ロール ARN の使用

クロスアカウントアクセスなど、クラウドサービスへの認可されたアクセスを必要とするアプリケーション向け。

はい

STS トークン

一時的

自動リフレッシュ

ECS インスタンス RAM ロールの使用

Alibaba Cloud Elastic Compute Service (ECS) インスタンス、Elastic Container Instance (ECI) インスタンス、または Container Service for Kubernetes (ACK) のワーカーノードで実行されるアプリケーション向け。

いいえ

STS トークン

一時的

自動リフレッシュ

OIDC ロール ARN の使用

Alibaba Cloud Container Service for Kubernetes (ACK) のワーカーノードで実行される信頼できないアプリケーション向け。

いいえ

STS トークン

一時的

自動リフレッシュ

Function Compute (FC) コンテキストからの認証情報の使用

Alibaba Cloud Function Compute (FC) で実行される関数向け。

いいえ

STS トークン

一時的

リフレッシュ不要

認証情報 URI の使用

外部システムから認証情報を取得する必要があるアプリケーション向け。

いいえ

STS トークン

一時的

自動リフレッシュ

自動ローテーションされる Access Key (AK) の使用

Access Key (AK) の漏洩リスクがある環境にデプロイされ、クラウドサービスへの長期アクセスに頻繁な認証情報ローテーションが必要なアプリケーション向け。

いいえ

Access Key (AK)

長期

自動ローテーション

カスタム認証情報プロバイダーの使用

上記の方法が要件を満たさない場合、認証情報を取得するためのカスタムメソッドを定義できます。

カスタム

カスタム

カスタム

カスタム

RAM ユーザー AK

頻繁な認証情報ローテーションなしで長期的な OSS アクセスが必要な、安全で安定した環境に適しています。RAM ユーザーの AccessKey (AK) で認証情報プロバイダーを初期化します。これには手動での AK メンテナンスが必要であり、セキュリティリスクが伴います。

重要
  • Alibaba Cloud アカウント (root ユーザー) はすべてのリソースに対して完全な権限を持っています。その AK が漏洩すると、システムが危険にさらされます。代わりに、最小限の権限を持つ RAM ユーザーの AK を使用してください。

  • RAM ユーザーの AK を作成するには、「AccessKey の作成」をご参照ください。AccessKey ID と AccessKey Secret は作成時にのみ表示されます。忘れた場合は、新しいものを作成してください。

環境変数

  1. RAM ユーザーの Access Key (AK) を使用して環境変数を設定します。

    Linux

    1. コマンドラインインターフェイスで次のコマンドを実行して、環境変数の設定を ~/.bashrc ファイルに追加します。

      echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
      echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc
    2. 次のコマンドを実行して変更を適用します。

      source ~/.bashrc
    3. 次のコマンドを実行して、環境変数が設定されていることを確認します。

      echo $OSS_ACCESS_KEY_ID
      echo $OSS_ACCESS_KEY_SECRET

    macOS

    1. ターミナルで次のコマンドを実行して、デフォルトのシェルタイプを表示します。

      echo $SHELL
    2. デフォルトのシェルタイプに基づいて、次の操作を実行します。

      Zsh

      1. 次のコマンドを実行して、環境変数の設定を ~/.zshrc ファイルに追加します。

        echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
        echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc
      2. 次のコマンドを実行して変更を適用します。

        source ~/.zshrc
      3. 次のコマンドを実行して、環境変数が設定されていることを確認します。

        echo $OSS_ACCESS_KEY_ID
        echo $OSS_ACCESS_KEY_SECRET

      Bash

      1. 次のコマンドを実行して、環境変数の設定を ~/.bash_profile ファイルに追加します。

        echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
        echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile
      2. 次のコマンドを実行して変更を適用します。

        source ~/.bash_profile
      3. 次のコマンドを実行して、環境変数が設定されていることを確認します。

        echo $OSS_ACCESS_KEY_ID
        echo $OSS_ACCESS_KEY_SECRET

    Windows

    CMD

    1. CMD で次のコマンドを実行します。

      setx OSS_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
      setx OSS_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"
    2. 次のコマンドを実行して、環境変数が設定されていることを確認します。

      echo %OSS_ACCESS_KEY_ID%
      echo %OSS_ACCESS_KEY_SECRET%

    PowerShell

    1. PowerShell で次のコマンドを実行します。

      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)
    2. 次のコマンドを実行して、環境変数が設定されていることを確認します。

      [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
      [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)
  2. 環境変数を変更した後、IDE、CLI、その他の実行環境を再起動またはリフレッシュして、新しい値を読み込みます。

  3. 環境変数を使用して認証情報を提供します。

    サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
    #!/usr/bin/env python3
    # -*- coding: utf-8 -*-
    
    # OSS Python SDK V1: クライアント初期化のサンプルコード
    
    import oss2
    from oss2.credentials import EnvironmentVariableCredentialsProvider
    
    def main():
    
        # 環境変数からアクセス認証情報を読み込みます。OSS_ACCESS_KEY_ID と OSS_ACCESS_KEY_SECRET を設定する必要があります。
        auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
        # OSS サービスリージョンを設定します。
        region = "<region-id>"
        # エンドポイントを設定します。
        endpoint = "<endpoint>"
        # バケット名を設定します。
        bucket_name = "example-bucket-hz"
    
        # OSS バケットインスタンスを初期化します。
        bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
        
        # バケット内のオブジェクトを一覧表示します。
        print("=== List objects in the bucket ===")
        try:
            # list_objects メソッドを使用してオブジェクトを一覧表示します。
            result = bucket.list_objects()
            
            # オブジェクトリストを反復処理し、オブジェクトキーのみを出力します。
            for obj in result.object_list:
                print(obj.key)
            
            # 統計情報を出力します。
            print(f"\nTotal objects listed: {len(result.object_list)}")
            if result.is_truncated:
                print("Note: The result is truncated. More objects are not listed.")
                
        except oss2.exceptions.OssError as e:
            print(f"OSS error: {e}")
            raise
        except Exception as e:
            print(f"An error occurred: {e}")
            raise
    
    if __name__ == "__main__":
        # プログラムのエントリポイント。
        try:
            main()
        except Exception as e:
            print(f"An error occurred during execution: {e}")
            raise
    

静的認証情報

次のサンプルコードは、アプリケーションに認証情報をハードコーディングする方法を示しています。

重要

本番環境のアプリケーションに認証情報を埋め込まないでください。この方法はテスト目的でのみ使用します。

サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# OSS Python SDK V1: クライアント初期化のサンプルコード

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

def main():

    # RAM ユーザーの AccessKey ID と AccessKey Secret を指定します。
    access_key_id = 'yourAccessKeyID'
    access_key_secret = 'yourAccessKeySecret'
    # RAM ユーザーの Access Key (AK) を使用してアクセス認証情報を設定します。
    auth = oss2.AuthV4(access_key_id, access_key_secret)
    # OSS サービスリージョンを設定します。
    region = "<region-id>"
    # エンドポイントを設定します。
    endpoint = "<endpoint>"
    # バケット名を設定します。
    bucket_name = "example-bucket-hz"

    # OSS バケットインスタンスを初期化します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # バケット内のオブジェクトを一覧表示します。
    print("=== List objects in the bucket ===")
    try:
        # list_objects メソッドを使用してオブジェクトを一覧表示します。
        result = bucket.list_objects()
        
        # オブジェクトリストを反復処理し、オブジェクトキーのみを出力します。
        for obj in result.object_list:
            print(obj.key)
        
        # 統計情報を出力します。
        print(f"\nTotal objects listed: {len(result.object_list)}")
        if result.is_truncated:
            print("Note: The result is truncated. More objects are not listed.")
            
    except oss2.exceptions.OssError as e:
        print(f"OSS error: {e}")
        raise
    except Exception as e:
        print(f"An error occurred: {e}")
        raise

if __name__ == "__main__":
    # プログラムのエントリポイント。
    try:
        main()
    except Exception as e:
        print(f"An error occurred during execution: {e}")
        raise

STS 一時認証情報

一時的な OSS アクセスが必要なアプリケーションに適しています。Security Token Service (STS) からの一時的な認証情報 (AccessKey ID、AccessKey Secret、セキュリティトークン) で認証情報プロバイダーを初期化します。STS トークンは有効期限が切れる前に手動でリフレッシュする必要があります。

重要

環境変数

  1. 一時的なアクセス認証情報を使用して環境変数を設定します。

    macOS、Linux、UNIX

    重要
    • RAM ユーザーの Access Key (AK) ではなく、STS から取得した一時的なアクセス認証情報 (Access Key ID、Access Key Secret、セキュリティトークン) を使用してください。

    • STS から取得した Access Key ID は「STS.」で始まります。例:「STS.**************」。

    export OSS_ACCESS_KEY_ID=<STS_ACCESS_KEY_ID>
    export OSS_ACCESS_KEY_SECRET=<STS_ACCESS_KEY_SECRET>
    export OSS_SESSION_TOKEN=<STS_SECURITY_TOKEN>

    Windows

    重要
    • RAM ユーザーの Access Key (AK) ではなく、STS から取得した一時的なアクセス認証情報 (Access Key ID、Access Key Secret、セキュリティトークン) を使用してください。

    • STS から取得した Access Key ID は「STS.」で始まります。例:「STS.**************」。

    set OSS_ACCESS_KEY_ID=<STS_ACCESS_KEY_ID>
    set OSS_ACCESS_KEY_SECRET=<STS_ACCESS_KEY_SECRET>
    set OSS_SESSION_TOKEN=<STS_SECURITY_TOKEN>
  2. 環境変数を使用して認証情報を提供します。

    サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
    # -*- coding: utf-8 -*-
    import oss2
    from oss2.credentials import EnvironmentVariableCredentialsProvider
    
    # yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = '<endpoint>'
    
    # yourBucketName は、バケット名を指定します。
    bucket_name = 'yourBucketName'
    
    # バケットが配置されているリージョンを指定します。
    region = '<region-id>'
    
    # 環境変数から STS AK、SK、およびセキュリティトークンを使用してアクセス認証情報を設定します。
    # ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
    auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
    
    # Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
    # そうしないと、エラーが発生します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # 後続の操作には bucket オブジェクトを使用します...

静的認証情報

アプリケーションに認証情報をハードコーディングし、一時的なアクセスキーを明示的に設定できます。

サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
# -*- coding: utf-8 -*-
import oss2

# Alibaba Cloud アカウントの AccessKey ID と AccessKey Secret ではなく、STS から取得した一時的な AccessKey ID と AccessKey Secret を指定します。
# STS から取得した Access Key ID は「STS.」で始まることに注意してください。
sts_access_key_id = 'STS.****************'
sts_access_key_secret = 'yourAccessKeySecret'
# STS から取得したセキュリティトークンを指定します。
security_token = 'yourSecurityToken'

# yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
endpoint = '<endpoint>'

# yourBucketName は、バケット名を指定します。
bucket_name = 'yourBucketName'

# バケットが配置されているリージョンを指定します。
region = '<region-id>'

# StsAuth インスタンスを初期化します。auth_version を "v4" に設定すると、OSS V4 署名が有効になることに注意してください。
auth = oss2.StsAuth(sts_access_key_id,
                    sts_access_key_secret,
                    security_token,
                    auth_version="v4")

# StsAuth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
# そうしないと、エラーが発生します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)

# 後続の操作には bucket オブジェクトを使用します...

RAM ロール ARN

クロスアカウントアクセスに適しています。RAM ロール ARN で認証情報プロバイダーを初期化します。認証情報ツールは、有効期限が切れる前に AssumeRole を呼び出して STS トークンを自動的にリフレッシュします。policy パラメーターを設定して、権限をさらに制限できます。

重要
  • Alibaba Cloud アカウント (root ユーザー) はすべてのリソースに対して完全な権限を持っています。その AK が漏洩すると、システムが危険にさらされます。代わりに、最小限の権限を持つ RAM ユーザーの AK を使用してください。

  • RAM ユーザーの AK を作成するには、「AccessKey の作成」をご参照ください。AccessKey ID と AccessKey Secret は作成時にのみ表示されます。忘れた場合は、新しいものを作成してください。

  • RAM ロール ARN を取得するには、「RAM ロールの作成」をご参照ください。

  1. 認証情報の依存関係を追加します。

    pip install alibabacloud_credentials
  2. Access Key (AK) と RAM ロール ARN をアクセス認証情報として設定します。

    サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
    # -*- coding: utf-8 -*-
    import oss2
    from alibabacloud_credentials.client import Client
    from alibabacloud_credentials.models import Config
    from oss2 import CredentialsProvider
    from oss2.credentials import Credentials
    import os
    
    class CredentialProviderWrapper(CredentialsProvider):
        def __init__(self, client):
            self.client = client
    
        def get_credentials(self):
            credential = self.client.get_credential()
            access_key_id = credential.access_key_id
            access_key_secret = credential.access_key_secret
            security_token = credential.security_token
            return Credentials(access_key_id, access_key_secret, security_token)
    
    config = Config(
        # 環境変数から RAM ユーザーの Access Key (AccessKey ID と AccessKey Secret) を取得します。
        access_key_id=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
        access_key_secret=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
        type='ram_role_arn',
        # 引き受ける RAM ロールの ARN。例:acs:ram::123456789012****:role/adminrole。ALIBABA_CLOUD_ROLE_ARN 環境変数を使用して RoleArn を設定できます。
        role_arn='<RoleArn>',
        # ロールセッション名。ALIBABA_CLOUD_ROLE_SESSION_NAME 環境変数を使用して RoleSessionName を設定できます。
        role_session_name='<RoleSessionName>',
        # オプション。より制限的な権限ポリシー。例:{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
        policy='<Policy>',
        # オプション。ロールセッションの有効期間。
        role_session_expiration=3600
    )
    
    cred = Client(config)
    
    credentials_provider = CredentialProviderWrapper(cred)
    
    # ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
    auth = oss2.ProviderAuthV4(credentials_provider)
    
    # yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = '<endpoint>'
    
    # yourBucketName は、バケット名を指定します。
    bucket_name = 'yourBucketName'
    
    # バケットが配置されているリージョンを指定します。
    region = '<region-id>'
    
    # Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
    # そうしないと、エラーが発生します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # 後続の操作には bucket オブジェクトを使用します...

ECS インスタンス RAM ロール

ECS インスタンス、ECI インスタンス、または Container Service for Kubernetes (ACK) ワーカーノード上のアプリケーションに適しています。ECS インスタンス RAM ロールは、AK や STS トークンを提供することなく、ECS インスタンス、ECI インスタンス、または Container Service for Kubernetes (ACK) ワーカーノードで STS トークンの自動リフレッシュを可能にします。ロールを取得するには、「RAM ロールの作成」をご参照ください。インスタンスにアタッチするには、「インスタンス RAM ロール」をご参照ください。

  1. 認証情報の依存関係を追加します。

    pip install alibabacloud_credentials
  2. ECS インスタンス RAM ロールをアクセス認証情報として設定します。

    サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
    # -*- coding: utf-8 -*-
    import oss2
    from alibabacloud_credentials.client import Client
    from alibabacloud_credentials.models import Config
    from oss2 import CredentialsProvider
    from oss2.credentials import Credentials
    
    class CredentialProviderWrapper(CredentialsProvider):
        def __init__(self, client):
            self.client = client
    
        def get_credentials(self):
            credential = self.client.get_credential()
            access_key_id = credential.access_key_id
            access_key_secret = credential.access_key_secret
            security_token = credential.security_token
            return Credentials(access_key_id, access_key_secret, security_token)
    
    config = Config(
        type='ecs_ram_role',      # 認証情報タイプ。固定値:ecs_ram_role。
        role_name='<RoleName>'    # ECS インスタンスにアタッチされた RAM ロールの名前。オプション。設定しない場合、自動的に取得されます。リクエストを減らすために、このパラメーターを設定することを強く推奨します。
    )
    
    cred = Client(config)
    
    credentials_provider = CredentialProviderWrapper(cred)
    
    # ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
    auth = oss2.ProviderAuthV4(credentials_provider)
    
    # yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = '<endpoint>'
    
    # yourBucketName は、バケット名を指定します。
    bucket_name = 'yourBucketName'
    
    # バケットが配置されているリージョンを指定します。
    region = '<region-id>'
    
    # Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
    # そうしないと、エラーが発生します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # 後続の操作には bucket オブジェクトを使用します...

OIDC ロール ARN

信頼できないアプリケーションが ACK ワーカーノードで実行される場合、RRSA を使用して、ノードのインスタンス RAM ロール STS トークンを取得するのを防ぎます。クラスターは Pod ごとにサービスアカウント OIDC トークンファイルをマウントし、設定を環境変数に注入します。認証情報ツールは、AK や STS トークンを必要とせずに、AssumeRoleWithOIDC を介して OIDC トークンを STS トークンに交換します。「RRSA を使用して ServiceAccount の RAM 権限を設定し、Pod の権限隔離を実装する」をご参照ください。

  1. 認証情報の依存関係を追加します。

    pip install alibabacloud_credentials
  2. OIDC ロールをアクセス認証情報として設定します。

    サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
    # -*- coding: utf-8 -*-
    import oss2
    from alibabacloud_credentials.client import Client
    from alibabacloud_credentials.models import Config
    from oss2 import CredentialsProvider
    from oss2.credentials import Credentials
    import os
    
    class CredentialProviderWrapper(CredentialsProvider):
        def __init__(self, client):
            self.client = client
    
        def get_credentials(self):
            credential = self.client.get_credential()
            access_key_id = credential.access_key_id
            access_key_secret = credential.access_key_secret
            security_token = credential.security_token
            return Credentials(access_key_id, access_key_secret, security_token)
    
    config = Config(
        # 認証情報タイプ。固定値:oidc_role_arn。
        type='oidc_role_arn',
        # RAM ロールの ARN。ALIBABA_CLOUD_ROLE_ARN 環境変数を使用して RoleArn を設定できます。
        role_arn=os.environ.get('<RoleArn>'),
        # OIDC プロバイダーの ARN。ALIBABA_CLOUD_OIDC_PROVIDER_ARN 環境変数を使用して OidcProviderArn を設定できます。
        oidc_provider_arn=os.environ.get('<OidcProviderArn>'),
        # OIDC トークンファイルパス。ALIBABA_CLOUD_OIDC_TOKEN_FILE 環境変数を使用して OidcTokenFilePath を設定できます。
        oidc_token_file_path=os.environ.get('<OidcTokenFilePath>'),
        # ロールセッション名。ALIBABA_CLOUD_ROLE_SESSION_NAME 環境変数を使用して RoleSessionName を設定できます。
        role_session_name='<RoleSessionName>',
        # オプション。より制限的な権限ポリシー。例:{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
        policy='<Policy>',
        # セッションの有効期間。
        role_session_expiration=3600
    )
    
    cred = Client(config)
    
    credentials_provider = CredentialProviderWrapper(cred)
    
    # ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
    auth = oss2.ProviderAuthV4(credentials_provider)
    
    # yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = '<endpoint>'
    
    # yourBucketName は、バケット名を指定します。
    bucket_name = 'yourBucketName'
    
    # バケットが配置されているリージョンを指定します。
    region = '<region-id>'
    
    # Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
    # そうしないと、エラーが発生します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # 後続の操作には bucket オブジェクトを使用します...

Function Compute コンテキスト

FC で実行される関数に適しています。FC はサービスロールを引き受けて STS トークン (36 時間有効) を取得し、それをコンテキストの Credentials パラメーターを通じて渡します。関数の最大実行時間は 24 時間であるため、実行中にトークンは期限切れにならず、リフレッシュは不要です。FC に OSS へのアクセス権限を付与するには、「関数ロールを使用して Function Compute に他のクラウドサービスへのアクセス権限を付与する」をご参照ください。

FC コンテキストからの認証情報で認証情報プロバイダーを初期化します。

サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
# -*- coding: utf-8 -*-
import oss2
from oss2 import CredentialsProvider
from oss2.credentials import Credentials

def handler(event, context):

    class CredentialProviderWrapper(CredentialsProvider):
        def get_credentials(self):
            creds = context.credentials
            return Credentials(creds.access_key_id, creds.access_key_secret, creds.security_token)

    credentials_provider = CredentialProviderWrapper()
    # ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
    auth = oss2.ProviderAuthV4(credentials_provider)

    # yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = '<endpoint>'

    # yourBucketName は、バケット名を指定します。
    bucket_name = 'yourBucketName'

    # バケットが配置されているリージョンを指定します。
    region = '<region-id>'

    # Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
    # そうしないと、エラーが発生します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)

    # 後続の操作には bucket オブジェクトを使用します...

    return 'success'

認証情報 URI

外部システムから認証情報を取得するアプリケーションに適しています。認証情報ツールは、提供された URI から STS トークンを取得し、自動リフレッシュを処理します。

重要
  • 認証情報 URI は、STS トークンを取得するためのサーバーアドレスです。

  • 認証情報 URI 応答を提供するバックエンドサービスは、アプリケーションが常に有効な認証情報を取得できるように、自動 STS トークンリフレッシュロジックを実装する必要があります。

  1. 認証情報ツールが STS トークンを正しく解析して使用できるように、URI 応答は次のプロトコルに準拠する必要があります。

    • 応答ステータスコード:200

    • 応答本文の構造:

      {
          "Code": "Success",
          "AccessKeySecret": "AccessKeySecret",
          "AccessKeyId": "AccessKeyId",
          "Expiration": "2021-09-26T03:46:38Z",
          "SecurityToken": "SecurityToken"
      }
  2. 認証情報の依存関係を追加します。

    pip install alibabacloud_credentials
  3. 認証情報 URI をアクセス認証情報として設定します。

    サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
    # -*- coding: utf-8 -*-
    import oss2
    from alibabacloud_credentials.client import Client
    from alibabacloud_credentials.models import Config
    from oss2 import CredentialsProvider
    from oss2.credentials import Credentials
    
    class CredentialProviderWrapper(CredentialsProvider):
        def __init__(self, client):
            self.client = client
    
        def get_credentials(self):
            credential = self.client.get_credential()
            access_key_id = credential.access_key_id
            access_key_secret = credential.access_key_secret
            security_token = credential.security_token
            return Credentials(access_key_id, access_key_secret, security_token)
    
    config = Config(
        type='credentials_uri',
        # 認証情報の URI。形式は http://local_or_remote_uri/ です。ALIBABA_CLOUD_CREDENTIALS_URI 環境変数を使用して CredentialsUri を設定できます。
        credentials_uri='<CredentialsUri>',
    )
    
    cred = Client(config)
    
    credentials_provider = CredentialProviderWrapper(cred)
    
    # ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
    auth = oss2.ProviderAuthV4(credentials_provider)
    
    # yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = '<endpoint>'
    
    # yourBucketName は、バケット名を指定します。
    bucket_name = 'yourBucketName'
    
    # バケットが配置されているリージョンを指定します。
    region = '<region-id>'
    
    # Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
    # そうしないと、エラーが発生します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # 後続の操作には bucket オブジェクトを使用します...

自動ローテーションされる AK

AK が漏洩するリスクがある環境に適しています。Key Management Service (KMS) の ClientKey で認証情報プロバイダーを初期化し、管理対象の RAM ユーザー AK を自動的にローテーションします。KMS は、AK が漏洩した場合の即時ローテーションもサポートしています。ClientKey を取得するには、「アプリケーションアクセスポイントの作成」をご参照ください。

  1. Secrets Manager クライアントの依存関係を追加します。

    pip install aliyun-secret-manager-client
  2. secretsmanager.properties という名前の設定ファイルを作成します。

    # アクセス認証情報のタイプ。固定値:client_key
    credentials_type=client_key
    
    # ClientKey の復号パスワード。環境変数またはファイルから読み取ることができます。いずれか一方のみ設定してください。
    client_key_password_from_env_variable=<your client key private key password environment variable name>
    client_key_password_from_file_path=<your client key private key password file path>
    
    # ClientKey の秘密鍵ファイルへのパス。
    client_key_private_key_path=<your client key private key file path>
    
    # 関連する KMS のリージョン。
    cache_client_region_id=[{"regionId":"<regionId>"}]
  3. 設定ファイルを使用して認証情報を提供します。

    サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
    # -*- coding: utf-8 -*-
    import json
    import oss2
    from oss2 import CredentialsProvider
    from oss2.credentials import Credentials
    from alibaba_cloud_secretsmanager_client.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
    
    class CredentialProviderWrapper(CredentialsProvider):
        def get_credentials(self):
            secret_cache_client = SecretManagerCacheClientBuilder.new_client()
            secret_info = secret_cache_client.get_secret_info("<secretName>")
            secret_value_json = json.loads(secret_info.secret_value)
            return Credentials(secret_value_json["AccessKeyId"], secret_value_json["AccessKeySecret"])
    
    credentials_provider = CredentialProviderWrapper()
    
    # ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
    auth = oss2.ProviderAuthV4(credentials_provider)
    
    # yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
    endpoint = '<endpoint>'
    
    # yourBucketName は、バケット名を指定します。
    bucket_name = 'yourBucketName'
    
    # バケットが配置されているリージョンを指定します。
    region = '<region-id>'
    
    # Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
    # そうしないと、エラーが発生します。
    bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)
    
    # 後続の操作には bucket オブジェクトを使用します...

カスタム認証情報プロバイダー

上記のどの認証情報設定方法も要件を満たさない場合は、CredentialProvider インターフェイスを実装してカスタム認証情報プロバイダーを定義できます。実装で STS トークンを使用する場合は、認証情報のリフレッシュも処理する必要があります。

サンプルコードを実行する前に、<region-id> などのプレースホルダーを実際のリージョンとエンドポイントに置き換えてください。たとえば、<region-id> を ap-southeast-1 に置き換えます。
# -*- coding: utf-8 -*-
import oss2
from oss2 import CredentialsProvider
from oss2.credentials import Credentials

class CredentialProviderWrapper(CredentialsProvider):
    def get_credentials(self):
        # TODO
        # アクセス認証情報を取得するためのカスタムメソッドを実装します。

        # 長期的な認証情報を返します:access_key_id, access_key_secret
        return Credentials('<access_key_id>', '<access_key_secrect>')

        # 一時的な認証情報を返します:access_key_id, access_key_secret, token
        # 一時的な認証情報の場合、有効期限に基づいてリフレッシュする必要があります。
        # return Credentials('<access_key_id>', '<access_key_secrect>', '<token>');

credentials_provider = CredentialProviderWrapper()

# ProviderAuthV4 は V4 署名の使用を示していることに注意してください。
auth = oss2.ProviderAuthV4(credentials_provider)

# yourEndpoint は、バケットが配置されているリージョンのエンドポイントを指定します。
endpoint = '<endpoint>'

# yourBucketName は、バケット名を指定します。
bucket_name = 'yourBucketName'

# バケットが配置されているリージョンを指定します。
region = '<region-id>'

# Auth インスタンスを使用してバケットを初期化します。V4 署名を使用する場合、region パラメーターは必須です。
# そうしないと、エラーが発生します。
bucket = oss2.Bucket(auth, endpoint, bucket_name, region=region)

# 後続の操作には bucket オブジェクトを使用します...

よくある質問

エラー:No module named _crcfunext?

OSS Python SDK V1 を使用したアップロードとダウンロードは、ossutil や他の SDK などの他のツールよりも遅くなります。

  • 原因:

    システムに必要な Python.h ファイルがないため、crcmod のコンパイル中に _crcfunext.so ライブラリの生成に失敗します。crcmod の詳細については、crcmod の紹介をご参照ください。

  • ソリューション:

    crcmod の C 拡張モードが正しくインストールされていることを確認します。

    1. 次のコマンドを実行して Python 環境に入ります。

      python
    2. 次のコマンドを実行して、crcmod モジュールから _crcfunext C 拡張モジュールをインポートします。

      import crcmod._crcfunext

      次のエラーは、crcmod ライブラリの C 拡張モードのインストールに失敗したことを示します。

      Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
      ImportError: No module named _crcfunext                                 
    3. ご利用のオペレーティングシステムに基づいて解決策を選択してください。

      Windows

      1. crcmod-1.7.win32-py2.7.msi または他のバージョンの .msi ファイルをダウンロードします。

        説明

        32 ビット版の crcmod は、32 ビットと 64 ビットの両方の Windows システムと互換性があります。

      2. .msi ファイルをインストールし、インストールプロセス中に、crcmod のインストールパスをローカルの Python インストールディレクトリの Lib\site-packages フォルダに指定します。例:D:\python\Lib\site-packages\。

      3. インストールが完了したら、crcmod の検証手順を再度実行します。

      Linux

      この問題が Linux システムで発生した場合は、次の手順を実行します。

      1. 次のコマンドを実行して crcmod をアンインストールします。

        pip uninstall crcmod
      2. python-devel をインストールします。「環境の準備」をご参照ください。

      3. 次のコマンドを実行して crcmod を再インストールします。

        pip install crcmod

        インストールが再度失敗した場合は、crcmod をアンインストールし、次のコマンドを実行して詳細なエラー情報を表示します。

        pip install crcmod -v

エラー:No module named 'Crypto'?

  • 原因:

    システムに Crypto モジュールが存在しないか、crypto モジュール (先頭が小文字) が存在します。

  • ソリューション:

    ローカルの Python インストールパス (例:D:\python3.9\Lib\site-packages) で Crypto モジュールを確認します。

    • Crypto モジュールが存在しない場合は、次のコマンドを実行します。

      python -m pip install --upgrade setuptools
    • crypto (c が小文字) という名前のモジュールが存在する場合は、それを Crypto に名前変更してからプログラムを再起動します。

エラー:"not an internal or external command"?

Windows で「is not recognized as an internal or external command」というエラーが表示された場合は、Python と pip のインストールパス (通常は Python ディレクトリの Scripts フォルダ) を Path 環境変数に追加します。変更を有効にするには、コンピューターを再起動してください。

OSS Python SDK V1 のインストール失敗

インストールに失敗した場合は、アンインストールして再試行してください。

pip uninstall oss2            

OSS Python SDK V1 のアップグレード

次のコマンドを実行して SDK をアップグレードします。

 pip install --upgrade oss2

AccessDenied エラーのトラブルシューティング

AccessDenied エラーは権限が不十分であることを示します。次のようにトラブルシューティングしてください。

  1. 正しい AccessKey ID と AccessKey Secret を使用していることを確認してください。

  2. RAM ユーザーがバケットまたはオブジェクト操作に必要な権限を持っていることを確認してください。

  3. バケットポリシーを確認します:「Access denied by bucket policy」というエラーメッセージは、リクエストがバケットポリシーによってブロックされたことを示します。

リージョン内アクセスの転送速度の向上

より高速な転送のために、バケットと同じリージョンにある Alibaba Cloud プロダクト (ECS など) から、内部エンドポイントを使用して OSS にアクセスします。

AccessKey の表示と AccessKey Secret の管理

  1. RAM ユーザーの AccessKey を表示するには:RAM コンソールにログインし、特定のユーザーを選択して AccessKey 情報を表示します。

  2. RAM ユーザーの AccessKey Secret は作成時にのみ表示されます。紛失した場合は、RAM コンソールで新しい AccessKey を作成してください。「AccessKey の作成」をご参照ください。