如何使用Harmony SDK拷貝檔案 - Object Storage Service

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

注意事項

關於OSS支援的Region與Endpoint的對應關係，請參見地區和Endpoint。
要進行拷貝檔案，您必須擁有源檔案的讀許可權及目標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`

範例程式碼

您可以使用以下代碼在同一個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();