このトピックでは、バージョン管理が有効になっているバケット内のオブジェクトをコピーする方法について説明します。CopyObject メソッドを呼び出して 1 GB 未満のオブジェクトをコピーし、UploadPartCopy メソッドを呼び出して 1 GB を超えるオブジェクトをコピーできます。
注意事項
このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID
cn-hangzhouを使用します。デフォルトでは、パブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS でサポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。ファイルをコピーするには、
oss:GetObjectおよびoss:PutObject権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーのアタッチ」をご参照ください。
サンプルコード
オブジェクトのコピー
1 GB 未満のオブジェクトをコピーするには、CopyObject メソッドを呼び出して、同じリージョン内のソースバケットから宛先バケットにオブジェクトをコピーできます。
デフォルトでは、x-oss-copy-source はオブジェクトの現在のバージョンをコピーします。現在のバージョンが削除マーカーの場合、OSS は 404 Not Found エラーを返します。x-oss-copy-source に versionId を追加して、オブジェクトの特定のバージョンをコピーできます。削除マーカーはコピーできません。
オブジェクトの以前のバージョンを同じバケットにコピーできます。コピーされたバージョンが新しい現在のバージョンになり、オブジェクトの以前のバージョンが復元されます。
宛先バケットでバージョン管理が有効になっている場合、OSS はコピーされたオブジェクトの一意のバージョン ID を自動的に生成します。このバージョン ID は、応答の x-oss-version-id ヘッダーで返されます。宛先バケットでバージョン管理が無効または一時停止されている場合、OSS は null バージョン ID を持つバージョンを生成してコピーされたオブジェクトを作成し、null バージョン ID を持つ以前のバージョンを上書きします。
バージョン管理が有効または一時停止されている宛先バケットに追加可能オブジェクトをコピーすることはできません。
次のコードを使用してオブジェクトをコピーできます。
import argparse
import alibabacloud_oss_v2 as oss
# コマンドライン引数パーサーを作成し、スクリプトの目的 (バケット内のオブジェクトをコピーする) を記述します。
parser = argparse.ArgumentParser(description="copy object sample")
# 必須のリージョン、宛先バケット名、ソースバケット名、宛先オブジェクト名、ソースオブジェクト名、ソースオブジェクトのバージョン ID、およびオプションのエンドポイントを含むコマンドライン引数を定義します。
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the destination bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--key', help='The name of the destination object.', required=True)
parser.add_argument('--source_key', help='The name of the source object.', required=True)
parser.add_argument('--source_bucket', help='The name of the source bucket.', required=True)
parser.add_argument('--source_version_id', help='The version ID of the source object.',required=True)
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.copy_object(oss.CopyObjectRequest(
bucket=args.bucket, # 宛先バケット名。
key=args.key, # 宛先オブジェクト名。
source_key=args.source_key, # ソースオブジェクト名。
source_bucket=args.source_bucket, # ソースバケット名。
source_version_id=args.source_version_id, # ソースオブジェクトのバージョン ID。
))
# 操作結果に関する情報を出力して、リクエストのステータスを確認します。
print(f'status code: {result.status_code},'
f' request id: {result.request_id},'
f' version id: {result.version_id},'
f' hash crc64: {result.hash_crc64},'
f' source version id: {result.source_version_id},'
f' server side encryption: {result.server_side_encryption},'
f' server side data encryption: {result.server_side_data_encryption},'
f' last modified: {result.last_modified},'
f' etag: {result.etag},'
)
# このスクリプトが直接実行されるときに、main 関数を呼び出して処理ロジックを開始します。
if __name__ == "__main__":
main() # スクリプトのエントリポイント。プログラムのフローはここから始まります。マルチパートコピー
1 GB を超えるオブジェクトの場合は、マルチパートコピー (UploadPartCopy) を使用する必要があります。
デフォルトでは、UploadPartCopy 操作は、既存のオブジェクトの現在のバージョンからパートをコピーします。UploadPartCopyRequest リクエストに SourceVersionId パラメーターを含めることで、オブジェクトの特定のバージョンをコピーできます。
バージョン ID を指定せず、ソースオブジェクトの現在のバージョンが削除マーカーである場合、OSS は 404 Not Found エラーを返します。削除マーカーに対応するバージョン ID を指定した場合、OSS は 400 Bad Request エラーを返します。
次のコードを使用して、マルチパートコピーでオブジェクトをコピーできます。
import argparse
import alibabacloud_oss_v2 as oss
# コマンドライン引数パーサーを作成し、スクリプトの目的 (マルチパートコピーアップロードを同期的に実行する) を記述します。
parser = argparse.ArgumentParser(description="upload part copy synchronously sample")
# --region コマンドライン引数を追加して、バケットが配置されているリージョンを指定します。これは必須パラメーターです。
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# --bucket コマンドライン引数を追加して、宛先バケットの名前を指定します。これは必須パラメーターです。
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# --endpoint コマンドライン引数を追加して、他のサービスが OSS にアクセスするために使用できるドメイン名を指定します。これはオプションのパラメーターです。
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
# --key コマンドライン引数を追加して、宛先オブジェクトの名前を指定します。これは必須パラメーターです。
parser.add_argument('--key', help='The name of the object.', required=True)
# --source_bucket コマンドライン引数を追加して、ソースバケットの名前を指定します。これは必須パラメーターです。
parser.add_argument('--source_bucket', help='The name of the source bucket.', required=True)
# --source_key コマンドライン引数を追加して、ソースオブジェクトの名前を指定します。これは必須パラメーターです。
parser.add_argument('--source_key', help='The name of the source object.', required=True)
# --source_version_id コマンドライン引数を追加して、ソースオブジェクトのバージョン ID を指定します。これは必須パラメーターです。
parser.add_argument('--source_version_id', help='The version id of the source object.', required=True)
def main():
# コマンドライン引数を解析して、ユーザーが入力した値を取得します。
args = parser.parse_args()
# ID 検証のために、環境変数から OSS へのアクセスに必要な資格情報を読み込みます。
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_meta = client.get_object_meta(oss.GetObjectMetaRequest(
bucket=args.source_bucket,
key=args.source_key,
))
# マルチパートアップロードタスクを開始し、このプロセスを識別するための UploadId を返します。
result = client.initiate_multipart_upload(oss.InitiateMultipartUploadRequest(
bucket=args.bucket,
key=args.key,
))
# 各パートのサイズを定義します (ここでは 1 MB に設定)。
part_size = 1024 * 1024
total_size = result_meta.content_length # ソースファイルの合計サイズ。
part_number = 1 # パート番号は 1 から始まります。
upload_parts = [] # アップロードされたパートに関する情報を格納するために使用されます。
offset = 0 # 現在のバイトオフセット。
# すべてのデータがアップロードされるまでループします。
while offset < total_size:
num_to_upload = min(part_size, total_size - offset) # 今回アップロードするデータ量を計算します。
end = offset + num_to_upload - 1 # 終了位置を決定します。
# 実際のマルチパートコピーアップロード操作を実行します。
up_result = client.upload_part_copy(oss.UploadPartCopyRequest(
bucket=args.bucket,
key=args.key,
upload_id=result.upload_id,
part_number=part_number,
source_bucket=args.source_bucket,
source_key=args.source_key,
source_version_id=args.source_version_id, # これを実際のバージョン ID に置き換えます。
source_range=f'bytes={offset}-{end}', # ソースオブジェクト内の範囲を指定します。
))
# パートアップロードのステータス情報を出力します。
print(f'status code: {up_result.status_code},'
f' request id: {up_result.request_id},'
f' part number: {part_number},'
f' last modified: {up_result.last_modified},'
f' etag: {up_result.etag},'
f' source version id: {up_result.source_version_id},'
)
# 正常にアップロードされたパートの情報を記録します。
upload_parts.append(oss.UploadPart(part_number=part_number, etag=up_result.etag))
offset += num_to_upload # オフセットを更新します。
part_number += 1 # パート番号を更新します。
# アップロードされたすべてのパートをパート番号でソートします。
parts = sorted(upload_parts, key=lambda p: p.part_number)
# OSS サービスにリクエストを送信して、マルチパートアップロードを完了します。
result = client.complete_multipart_upload(oss.CompleteMultipartUploadRequest(
bucket=args.bucket,
key=args.key,
upload_id=result.upload_id,
complete_multipart_upload=oss.CompleteMultipartUpload(
parts=parts
)
))
# アップロード完了後に詳細な結果を出力します。
print(f'status code: {result.status_code},'
f' request id: {result.request_id},'
f' bucket: {result.bucket},'
f' key: {result.key},'
f' location: {result.location},'
f' etag: {result.etag},'
f' encoding type: {result.encoding_type},'
f' hash crc64: {result.hash_crc64},'
f' version id: {result.version_id},'
)
# このスクリプトが直接実行されるときに、main 関数を呼び出して処理ロジックを開始します。
if __name__ == "__main__":
main() # スクリプトのエントリポイント。プログラムのフローはここから始まります。関連情報
オブジェクトのコピーに関する完全なサンプルコードについては、「copy_object.py」をご参照ください。
マルチパートコピーの実行に関する完全なサンプルコードについては、「upload_part_copy.py」をご参照ください。