Harmony拷贝文件

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

注意事项

  • 关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

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

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

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

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM PolicyBucket Policy授予操作权限。

API

Action

说明

CopyObject

oss:GetObject

拷贝同一地域下相同或不同存储空间(Bucket)之间的文件(Object)。

oss:PutObject

oss:GetObjectVersion

如果通过versionId指定拷贝的源Object版本,还需要此操作的权限。

oss:GetObjectTagging

如果通过x-oss-tagging拷贝Object的标签,则需要此操作的权限。

oss:PutObjectTagging

oss:GetObjectVersionTagging

如果通过versionId指定拷贝的源Object特定版本的Object的标签,还需要此操作的权限。

kms:GenerateDataKey

拷贝Object时,如果目标Object的元数据包含X-Oss-Server-Side-Encryption: KMS,则需要这两个权限。

kms:Decrypt

示例代码

您可以使用以下代码在同一个Bucket中复制对象。

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

/**
 * 在同一个Bucket中复制对象。
 * 使用copyObject方法将源对象复制到目标对象。
 */
const copyObject = async () => {
  try {
    // 调用copyObject方法在同一Bucket中复制对象
    const res = await client.copyObject({
      bucket: 'targetBucket', // 目标Bucket名称,请替换为您实际的目标Bucket名称
      key: 'targetKey',       // 目标对象名称,请替换为您实际的目标对象名称
      copySourceKey: 'sourceKey', // 源对象名称,请替换为您实际的源对象名称
    });

    // 打印复制结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      console.log('unknown error: ', err);
    }
  }
};

// 调用copyObject函数执行在同一个Bucket中复制对象的操作
copyObject();

常见使用场景

将同一地域下源Bucket中的对象复制到目标Bucket

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});


/**
 * 从其他Bucket中复制对象。
 * 使用copyObject方法将源Bucket中的对象复制到目标Bucket。
 */
const copyObjectFromOtherBucket = async () => {
  try {
    // 调用copyObject方法从其他Bucket中复制对象
    const res = await client.copyObject({
      bucket: 'targetBucket', // 目标Bucket名称,请替换为您实际的目标Bucket名称
      key: 'targetKey',       // 目标对象名称,请替换为您实际的目标对象名称
      copySourceBucket: 'sourceBucket', // 源Bucket名称,请替换为您实际的源Bucket名称
      copySourceKey: 'sourceKey',       // 源对象名称,请替换为您实际的源对象名称
    });

    // 打印复制结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      console.log('unknown error: ', err);
    }
  }
};

// 调用copyObjectFromOtherBucket函数执行从其他Bucket复制对象的操作
copyObjectFromOtherBucket();