重新命名檔案以滿足命名規範 - Object Storage Service

在OSS資料移轉或重組過程中，您可以通過重新命名檔案確保命名一致性和結構準確性。儲存空間（Bucket）開啟階層命名空間後，允許在同一個Bucket內直接對檔案（Object）進行重新命名操作。

使用情境

命名規範實施：實施新的檔案命名規範時，需要重新命名現有對象以提高資料管理效率和一致性。
資料移轉和重組：在組織架構調整、系統遷移或應用程式升級時，可能需要重新命名和重組OSS中的資料。
儲存布局最佳化：為了改善資料檢索效能和組織圖，有時需要重新命名對象以最佳化儲存布局和虛擬目錄結構。

注意事項

在Bucket開啟階層命名空間的情況下，OSS支援直接調用Rename介面對Object進行重新命名。
關於階層命名空間的更多資訊，請參見使用階層命名空間。
在Bucket未開啟階層命名空間的情況下，OSS不支援直接對Object進行重新命名。如果您需要在同一個Bucket內對Object進行重新命名，您可以通過CopyObject介面將源Object拷貝至目標Object，然後通過DeleteObject介面刪除源Object。

操作步驟

使用OSS控制台

重要

OSS控制台對重新命名的Object大小無限制，移動的Object大小不能超過1 GB。

登入OSS管理主控台。
單擊Bucket 列表，然後單擊目標Bucket名稱。

重新命名Object。

Bucket未開啟階層命名空間
在左側導覽列，選擇文件管理 > 檔案清單，將滑鼠指標懸停在目標Object上，然後單擊表徵圖，對Object進行重新命名。重新命名時，Object名稱需包含尾碼。

Bucket已開啟階層命名空間

在左側導覽列，選擇文件管理 > 檔案清單，然後對Object執行重新命名或移動操作。

情境

操作

重新命名Object

將滑鼠指標懸停在目標Object上，然後單擊表徵圖 edit ，對Object進行重新命名。重新命名時，Object名稱需包含尾碼。

移動Object

選擇目標Object右側操作列表下的更多 > 移動文件。在移動文件頁面，根據如下情境填寫符合要求的目標目錄。

如果您希望將Object移動至當前Bucket的根目錄下，請將目標目錄置空。
如果您希望將Object移動至當前Bucket的指定目錄下，例如移動至父目錄destdir下的子目錄subdir，則目標目錄填寫為destdir/subdir。

使用阿里雲SDK

例如，將examplebucket中的srcobject.txt重新命名為destobject.txt。配置樣本如下：

Java

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.RenameObjectRequest;

public class Demo {

    public static void main(String[] args) throws Exception {
        // Endpoint以華東1（杭州）為例，其它Region請按實際情況填寫。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 強烈建議不要把訪問憑證儲存到工程代碼裡，否則可能導致訪問憑證泄露，威脅您帳號下所有資源的安全。本程式碼範例以從環境變數中擷取訪問憑證為例。運行本程式碼範例之前，請先配置環境變數。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // 填寫Bucket名稱。
        String bucketName = "examplebucket";
        // 填寫源Object的完整路徑，完整路徑中不能包含Bucket名稱。
        String sourceObject = "srcobject.txt";
        // 填寫目標Object的完整路徑。Object完整路徑中不能包含Bucket名稱。
        String destinationObject = "destobject.txt";

        // 建立OSSClient執行個體。
        OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

        try {
            // 如果Bucket已開啟階層命名空間，請使用以下代碼進行Object重新命名操作。
            // 將儲存空間中的源Object絕對路徑重新命名為目標Object絕對路徑。
            RenameObjectRequest renameObjectRequest = new RenameObjectRequest(bucketName, sourceObject, destinationObject);
            ossClient.renameObject(renameObjectRequest);

            // 如果Bucket未開啟階層命名空間，請使用以下代碼進行Object重新命名操作。
            // 將examplebucket下的srcobject.txt拷貝至同一Bucket下的destobject.txt。
            // ossClient.copyObject(bucketName, sourceObject, bucketName, destinationObject);

            // 刪除srcobject.txt。
            // ossClient.deleteObject(bucketName, sourceObject);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

Node.js

const OSS = require('ali-oss');
const client = new OSS({
  // yourregion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
  region: 'oss-cn-hangzhou',
  // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  authorizationV4: true,
  // 填寫Bucket名稱。
  bucket: 'examplebucket',
})

async function renameObject() {
  try {
    // 將srcobject.txt拷貝至同一Bucket下的destobject.txt。
    const r = await client.copy('destobject.txt', 'srcobject.txt');
    console.log('拷貝成功', r);
    // 刪除srcobject.txt。
    const deleteResult = await client.delete('srcobject.txt');
    console.log(deleteResult);
  } catch (e) {
    console.log(e);
  }
}

renameObject();

Android-Java

// 填寫Bucket名稱。
String bucketName = "examplebucket";
// 填寫不包含Bucket名稱在內源Object的完整路徑，例如srcobject.txt。
String sourceObjectKey = "srcobject.txt";
// 填寫不包含Bucket名稱在內目標Object的完整路徑，例如destobject.txt。
String objectKey = "destobject.txt";
try {
    CopyObjectRequest copyObjectRequest = new CopyObjectRequest(bucketName, sourceObjectKey, bucketName, objectKey);
    oss.copyObject(copyObjectRequest);
    // 刪除srcobject.txt。
    DeleteObjectRequest deleteObjectRequest = new DeleteObjectRequest(bucketName, sourceObjectKey);
    oss.deleteObject(deleteObjectRequest);
} catch (ClientException e) {
    // 用戶端異常，例如網路異常等。
    e.printStackTrace();
} catch (ServiceException e) {
    // 服務端異常。
    Log.e("RequestId", e.getRequestId());
    Log.e("ErrorCode", e.getErrorCode());
    Log.e("HostId", e.getHostId());
    Log.e("RawMessage", e.getRawMessage());
}

Object C

// 填寫Bucket名稱。
NSString *bucketName = @"examplebucket";
// 填寫不包含Bucket名稱在內源Object的完整路徑，例如srcobject.txt。
NSString *sourceObjectKey = @"sourceObjectKey";
// 填寫不包含Bucket名稱在內目標Object的完整路徑，例如destobject.txt。
NSString *objectKey = @"destobject.txt";
[[[OSSTask taskWithResult:nil] continueWithBlock:^id _Nullable(OSSTask * _Nonnull task) {
    // 將srcobject.txt拷貝至同一Bucket下的destobject.txt。
    OSSCopyObjectRequest *copyRequest = [OSSCopyObjectRequest new];
    copyRequest.bucketName = bucketName;
    copyRequest.sourceBucketName = bucketName;
    copyRequest.sourceObjectKey = sourceObjectKey;
    copyRequest.objectKey = objectKey;
    OSSTask *copyTask = [client copyObject:copyRequest];
    [copyTask waitUntilFinished];
    if (copyTask.error) {
        return copyTask;
    }
    // 刪除srcobject.txt。
    OSSDeleteObjectRequest *deleteObject = [OSSDeleteObjectRequest new];
    deleteObject.bucketName = bucketName;
    deleteObject.objectKey = sourceObjectKey;
    OSSTask *deleteTask = [client deleteObject:deleteObject];
    [deleteTask waitUntilFinished];
    if (deleteTask.error) {
        return deleteTask;
    }
    return nil;
}] continueWithBlock:^id _Nullable(OSSTask * _Nonnull task) {
    if (task.error) {
        NSLog(@"rename fail! error: %@", task.error);
    } else {
        NSLog(@"rename success!");
    }
    return nil;
}];

Python

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,  # 指定源儲存空間名稱
    ))
    
    # 刪除原有對象
    client.delete_object(oss.DeleteObjectRequest(
        bucket=args.source_bucket,
        key=args.source_key
    ))

    # 輸出複製對象的結果資訊
    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函數

PHP

<?php

// 引入自動負載檔案，確保依賴庫能夠正確載入
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 定義命令列參數的描述資訊
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // Bucket所在的地區（必填）
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 訪問網域名稱（可選）
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // 目標Bucket名稱（必填）
    "key" => ['help' => 'The name of the object', 'required' => True], // 目標對象名稱（必填）
    "src-bucket" => ['help' => 'The name of the source bucket', 'required' => False], // 源Bucket名稱（可選）
    "src-key" => ['help' => 'The name of the source object', 'required' => True], // 來源物件名稱（必填）
];

// 將參數描述轉換為getopt所需的長選項格式
// 每個參數後面加上":"表示該參數需要值
$longopts = \array_map(function ($key) {
    return "$key:";
}, array_keys($optsdesc));

// 解析命令列參數
$options = getopt("", $longopts);

// 驗證必填參數是否存在
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help']; // 擷取參數的協助資訊
        echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
        exit(1); // 如果必填參數缺失，則退出程式
    }
}

// 從解析的參數中提取值
$region = $options["region"]; // Bucket所在的地區
$bucket = $options["bucket"]; // 目標Bucket名稱
$key = $options["key"];       // 目標對象名稱
$srcKey = $options["src-key"]; // 來源物件名稱

// 載入環境變數中的憑證資訊
// 使用EnvironmentVariableCredentialsProvider從環境變數中讀取Access Key ID和Access Key Secret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// 使用SDK的預設配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者
$cfg->setRegion($region); // 設定Bucket所在的地區
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了訪問網域名稱，則設定endpoint
}

// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg);

// 建立CopyObjectRequest對象，用於複製對象
$request = new Oss\Models\CopyObjectRequest(
            bucket: $bucket,
            key: $key,
            sourceKey: $srcKey,
            sourceBucket: $bucket);

if (!empty($options["src-bucket"])) {
    $request->sourceBucket = $options["src-bucket"]; // 如果提供了源Bucket名稱，則設定sourceBucket
}
$request->sourceKey = $srcKey; // 設定來源物件名稱

// 執行複製對象操作
$result = $client->copyObject($request);

// 列印複製結果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL     // 請求ID，用於調試或追蹤請求
);

關於其他SDK的重新命名Object的程式碼範例，請參見SDK簡介。

使用圖形化管理工具ossbrowser

ossbrowser支援Bucket層級的操作與控制台支援的操作類似，請按照ossbrowser介面指引完成重新命名檔案的操作。關於如何使用ossbrowser，請參見常用操作。

使用命令列工具ossutil

例如，將examplebucket1中的examplefile.txt重新命名為example.txt。配置樣本如下：

ossutil cp oss://examplebucket1/examplefile.txt oss://examplebucket1/example.txt 
ossutil rm oss://examplebucket1/examplefile.txt

關於使用ossutil重新命名Object的具體步驟，請參見cp（拷貝檔案）和rm（刪除）。

使用REST API

如果您的程式自訂要求較高，您可以直接發起REST API請求。直接發起REST API請求需要手動編寫代碼計算簽名。更多資訊，請參見Rename。

Object Storage Service：重新命名檔案以滿足命名規範