Go拷贝对象

本文介绍如何使用Go SDK V2CopyObject方法,将源Bucket中的对象(5GiB 以下)拷贝到同一地域下相同或不同目标Bucket中。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见配置访问凭证

  • 要进行拷贝文件,您必须拥有源文件的读权限及目标Bucket的读写权限。

  • 不支持跨地域拷贝。例如不能将华东1(杭州)地域存储空间中的文件拷贝到华北1(青岛)地域。

  • 拷贝文件时,您需要确保源Bucket和目标Bucket均未设置合规保留策略,否则报错The object you specified is immutable.

方法定义

func (c *Client) CopyObject(ctx context.Context, request *CopyObjectRequest, optFns ...func(*Options)) (*CopyObjectResult, error)

请求参数列表

参数名

类型

说明

ctx

context.Context

请求的上下文,可以用来设置请求的总时限

request

*CopyObjectRequest

设置具体接口的请求参数,具体请参见CopyObjectRequest

optFns

...func(*Options)

(可选)配置选项,具体请参见Options

其中,CopyObjectRequest的常用参数列举如下:

参数名

类型

说明

Bucket

*string

指定目标存储空间名称

Key

*string

指定目标对象名称

SourceBucket

*string

指定源存储空间名称

SourceKey

*string

指定源对象名称

ForbidOverwrite

*string

指定CopyObject操作时是否覆盖同名目标Object

Tagging

*string

指定Object的对象标签,可同时设置多个标签,例如TagA=A&TagB=B。

TaggingDirective

*string

指定如何设置目标Object的对象标签。取值如下:

  • Copy(默认值):复制源Object的对象标签到目标 Object。

  • Replace:忽略源Object的对象标签,直接采用请求中指定的对象标签。

返回值列表

返回值名

类型

说明

result

*CopyObjectResult

接口返回值,当 err 为nil 时有效,具体请参见CopyObjectResult

err

error

请求的状态,当请求失败时,err 不为 nil

示例代码

您可以使用以下代码将小于5GiB的对象从源存储空间拷贝到目标存储空间。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定义全局变量
var (
	region         string // 存储区域
	srcBucketName  string // 源存储空间名称
	srcObjectName  string // 源对象名称
	destBucketName string // 目标存储空间名称
	destObjectName string // 目标对象名称
)

// init函数用于初始化命令行参数
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&srcBucketName, "src-bucket", "", "The name of the source bucket.")
	flag.StringVar(&srcObjectName, "src-object", "", "The name of the source object.")
	flag.StringVar(&destBucketName, "dest-bucket", "", "The name of the destination bucket.")
	flag.StringVar(&destObjectName, "dest-object", "", "The name of the destination object.")
}

func main() {
	// 解析命令行参数
	flag.Parse()

	// 检查源bucket名称是否为空
	if len(srcBucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, source bucket name required")
	}

	// 检查region是否为空
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 如果目标bucket名称未指定,则使用源bucket名称
	if len(destBucketName) == 0 {
		destBucketName = srcBucketName
	}

	// 检查源object名称是否为空
	if len(srcObjectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, source object name required")
	}

	// 检查目标object名称是否为空
	if len(destObjectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, destination object name required")
	}

	// 加载默认配置并设置凭证提供者和区域
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 创建复制对象请求
	request := &oss.CopyObjectRequest{
		Bucket:       oss.Ptr(destBucketName), // 目标存储空间名称
		Key:          oss.Ptr(destObjectName), // 目标对象名称
		SourceKey:    oss.Ptr(srcObjectName),  // 源对象名称
		SourceBucket: oss.Ptr(srcBucketName),  // 源存储空间名称
	}

	// 执行复制对象操作并处理结果
	result, err := client.CopyObject(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to copy object %v", err)
	}
	log.Printf("copy object result:%#v\n", result)
}

相关文档

  • 关于拷贝对象的完整示例代码,请参见GitHub示例

  • 关于拷贝对象的API接口,请参见CopyObject