如何使用OSS Python SDK V2进行拷贝对象_对象存储(OSS)-阿里云帮助中心

本文介绍如何使用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.。

方法定义

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函数

Python拷贝对象

注意事项

方法定义

请求参数列表

返回值列表

示例代码

相关文档