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

Object Storage Service:OSS SDK for Python 2.0 を使用した同期処理

最終更新日:Aug 13, 2025

同期処理では、プログラムは現在のタスクを完了してから、追加のタスクの実行を開始する必要があります。Object Storage Service (OSS) のデータを同期的に処理するには、x-oss-process パラメーターを使用できます。このトピックでは、画像処理やドキュメント処理などの同期処理シナリオで Python V2 用 OSS SDK を使用する方法について説明します。

使用上の注意

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

メソッド定義

process_object(request: ProcessObjectRequest, **kwargs) → ProcessObjectResult

リクエストパラメーター

パラメーター

タイプ

説明

request

ProcessObjectRequest

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

レスポンスパラメーター

タイプ

説明

ProcessObjectResult

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

完全なメソッド定義については、「process_object」をご参照ください。

サンプルコード

次のサンプルコードは、Python V2 用 OSS SDK を使用して画像のサイズを変更し、サイズ変更後の画像を指定されたバケットに保存します。

import base64
import argparse
import alibabacloud_oss_v2 as oss

# コマンドライン引数を解析するためのパーサーを作成し、スクリプトの目的を記述します。
parser = argparse.ArgumentParser(description="process object sample")

# 必須のリージョン、ソースバケット名、エンドポイント、ソースオブジェクト名、スタイル、デスティネーションオブジェクト名、デスティネーションバケット名を含む、コマンドライン引数を指定します。
parser.add_argument('--region', help='バケットが配置されているリージョン。', required=True)
parser.add_argument('--bucket', help='バケットの名前。', required=True)
parser.add_argument('--endpoint', help='他のサービスが OSS にアクセスするために使用できるドメイン名')
parser.add_argument('--key', help='オブジェクトの名前。', required=True)
parser.add_argument('--style', help='オブジェクトの処理に適用するスタイル (画像のサイズ変更など)。', required=True)
parser.add_argument('--target_image', help='処理された画像の名前を指定します。', required=True)
parser.add_argument('--target_bucket', help='処理された画像の保存に使用するバケットの名前を指定します。', required=True)

def main():
    # コマンドライン引数を解析します。
    args = parser.parse_args()

    # 認証のために環境変数からアクセス認証情報を取得します。
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

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

    # cfg オブジェクトのリージョン属性を、コマンドラインで指定されたリージョンに設定します。
    cfg.region = args.region

    # カスタムエンドポイントが指定されている場合は、cfg オブジェクトのエンドポイント属性を指定されたエンドポイントで更新します。
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 前述の設定を使用して、OSSClient インスタンスを初期化します。
    client = oss.Client(cfg)

    # オブジェクトを処理するためのスタイルを取得します。
    # 次のサンプルスタイルは、画像のサイズを変更します: style = 'image/resize,m_fixed,w_100,h_100'
    style = args.style

    # デスティネーションバケット名とオブジェクト名を Base64 エンコードして、URL セーフにします。
    target_bucket_base64 = base64.b64encode(args.target_bucket.encode()).decode()
    target_key_base64 = base64.b64encode(args.target_image.encode()).decode()

    # スタイルとデスティネーションバケット名を含む処理命令を作成します。
    process = f"{style}|sys/saveas,o_{target_key_base64},b_{target_bucket_base64}"

    # オブジェクトを処理し、結果のオブジェクトをデスティネーションバケットに保存するリクエストを送信します。
    result = client.process_object(oss.ProcessObjectRequest(
        bucket=args.bucket,  # ソースバケット名。
        key=args.key,  # ソースオブジェクト名。
        process=process, # 処理命令。
    ))

    # リクエストのステータスと結果を確認するために、ステータスコードとその他の結果情報を表示します。
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' bucket: {result.bucket},'
          f' file size: {result.file_size},'
          f' key: {result.key},'
          f' process status: {result.process_status},'
          )

# スクリプトが直接実行されたときに処理ロジックを開始するために、main 関数を呼び出します。
if __name__ == "__main__":
    main()  # スクリプトのエントリポイントを指定します。制御フローはここから開始されます。

一般的なシナリオ

画像に不可視ウォーターマークを追加する

不可視ウォーターマーク機能を使用すると、画像に不可視テキストウォーターマークを追加できます。次のサンプルコードは、画像に不可視ウォーターマークを追加します。

import base64
import argparse
import alibabacloud_oss_v2 as oss

# コマンドライン引数を解析するためのパーサーを作成し、スクリプトの目的を記述します。
parser = argparse.ArgumentParser(description="process object sample")

# 必須のリージョン、ソースバケット名、エンドポイント、ソースオブジェクト名、スタイル、デスティネーションオブジェクト名、デスティネーションバケット名を含む、コマンドライン引数を指定します。
parser.add_argument('--region', help='バケットが配置されているリージョン。', required=True)
parser.add_argument('--bucket', help='バケットの名前。', required=True)
parser.add_argument('--endpoint', help='他のサービスが OSS にアクセスするために使用できるドメイン名')
parser.add_argument('--key', help='オブジェクトの名前。', required=True)
parser.add_argument('--target_image', help='処理された画像の名前を指定します。', required=True)
parser.add_argument('--target_bucket', help='処理された画像の保存に使用するバケットの名前を指定します。', required=True)

def main():
    # コマンドライン引数を解析します。
    args = parser.parse_args()

    # 認証のために環境変数からアクセス認証情報を取得します。
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

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

    # cfg オブジェクトのリージョン属性を、コマンドラインで指定されたリージョンに設定します。
    cfg.region = args.region

    # カスタムエンドポイントが指定されている場合は、cfg オブジェクトのエンドポイント属性を指定されたエンドポイントで更新します。
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 前述の設定を使用して、OSSClient インスタンスを初期化します。
    client = oss.Client(cfg)

    # ウォーターマークコンテンツを指定します。
    content = "Copyrighted by Alibaba Cloud"

    # 不可視ウォーターマークを生成します。
    encoded_content = base64.urlsafe_b64encode(content.encode()).decode()

    style = f"image/blindwatermark,content_{encoded_content}"

    # デスティネーションバケット名とオブジェクト名を Base64 エンコードして、URL セーフにします。
    target_bucket_base64 = base64.b64encode(args.target_bucket.encode()).decode()
    target_key_base64 = base64.b64encode(args.target_image.encode()).decode()

    # スタイルとデスティネーションバケット名を含む処理命令を作成します。
    process = f"{style}|sys/saveas,o_{target_key_base64},b_{target_bucket_base64}"

    # オブジェクトを処理し、結果のオブジェクトをデスティネーションバケットに保存するリクエストを送信します。
    result = client.process_object(oss.ProcessObjectRequest(
        bucket=args.bucket,  # ソースバケット名
        key=args.key,  # ソースオブジェクト名
        process=process, # 処理命令
    ))

    # リクエストのステータスと結果を確認するために、ステータスコードとその他の結果情報を表示します。
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' bucket: {result.bucket},'
          f' file size: {result.file_size},'
          f' key: {result.key},'
          f' process status: {result.process_status},'
          )


# スクリプトが直接実行されたときに処理ロジックを開始するために、main 関数を呼び出します。
if __name__ == "__main__":
    main()  # スクリプトのエントリポイントを指定します。制御フローはここから開始されます。

関連情報