如何使用OSS Python SDK V2進行拷貝對象 - Object Storage Service

本文介紹如何使用Python SDK V2的CopyObject方法，將源Bucket中的對象（5GiB 以下）拷貝到同一地區下相同或不同目標Bucket中。

注意事項

本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。
要進行拷貝檔案，您必須擁有源檔案的讀許可權及目標Bucket的讀寫權限。
不支援跨地區拷貝。例如不能將華東1（杭州）地區儲存空間中的檔案拷貝到華北1（青島）地區。
拷貝檔案時，您需要確保源Bucket和目標Bucket均未設定合規保留原則，否則報錯The object you specified is immutable.。

許可權說明

阿里雲帳號預設擁有全部許可權。阿里雲帳號下的RAM使用者或RAM角色預設沒有任何許可權，需要阿里雲帳號或帳號管理員通過RAM Policy或Bucket Policy授予操作許可權。

API	Action	說明
CopyObject	`oss:GetObject`	拷貝同一地區下相同或不同儲存空間（Bucket）之間的檔案（Object）。
	`oss:PutObject`	拷貝同一地區下相同或不同儲存空間（Bucket）之間的檔案（Object）。
	`oss:GetObjectVersion`	如果通過versionId指定拷貝的源Object版本，還需要此操作的許可權。
	`oss:GetObjectTagging`	如果通過x-oss-tagging拷貝Object的標籤，則需要此操作的許可權。
	`oss:PutObjectTagging`	如果通過x-oss-tagging拷貝Object的標籤，則需要此操作的許可權。
	`oss:GetObjectVersionTagging`	如果通過versionId指定拷貝的源Object特定版本的Object的標籤，還需要此操作的許可權。
	`kms:GenerateDataKey`	拷貝Object時，如果目標Object的中繼資料套件含X-Oss-Server-Side-Encryption: KMS，則需要這兩個許可權。
	`kms:Decrypt`

方法定義

copy_object(request: CopyObjectRequest, **kwargs) → CopyObjectResult

請求參數列表

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

其中，CopyObjectRequest的常用參數列舉如下：

參數名	類型	說明
bucket	str	指定目標儲存空間名稱
key	str	指定目標對象名稱
source_bucket	str	指定源儲存空間名稱
source_key	str	指定來源物件名稱
forbid_overwrite	str	指定CopyObject操作時是否覆蓋同名目標Object
tagging	str	指定Object的對象標籤，可同時設定多個標籤，例如TagA=A&TagB=B。
tagging_directive	str	指定如何設定目標Object的對象標籤。取值如下： Copy（預設值）：複製源Object的對象標籤到目標 Object。 Replace：忽略源Object的對象標籤，直接採用請求中指定的對象標籤。

傳回值列表

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

關於拷貝對象方法的完整定義，請參見copy_object。

範例程式碼

您可以使用以下代碼將小於5GiB的對象從源儲存空間拷貝到目標儲存空間。

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器
parser = argparse.ArgumentParser(description="copy object 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 destination 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 destination object.', required=True)
# 添加命令列參數 --source_key，表示來源物件的名稱，必需參數
parser.add_argument('--source_key', help='The name of the source object.', required=True)
# 添加命令列參數 --source_bucket，表示源儲存空間的名稱，必需參數
parser.add_argument('--source_bucket', help='The name of the source bucket.', required=True)

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用戶端
    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,  # 指定源儲存空間名稱
    ))

    # 輸出複製對象的結果資訊
    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()  # 指令碼入口，當檔案被直接運行時調用main函數

Object Storage Service：拷貝對象（Python SDK V2）