全部產品
Search
文件中心

Object Storage Service:重新命名檔案(Python SDK V2)

更新時間:Sep 17, 2025

OSS不支援直接對檔案(Object)進行重新命名。如果您需要在同一個Bucket內對Object進行重新命名,您可以通過CopyObject介面將源Object拷貝至目標Object並進行重新命名。

注意事項

  • 本文範例程式碼以華東1(杭州)的地區IDcn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱

範例程式碼

使用簡單拷貝(CopyObject)方法重新命名檔案

您可以使用簡單拷貝CopyObject方法重新命名檔案。

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

使用拷貝管理器(Copier)重新命名檔案

以下代碼展示了如何使用拷貝管理器中的Copier.Copy方法重新命名檔案。

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器
parser = argparse.ArgumentParser(description="copier sample")

# 添加命令列參數:region(必填),指定Bucket所在的地區
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)

# 添加命令列參數:bucket(必填),指定目標Bucket名稱
parser.add_argument('--bucket', help='The name of the 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 object.', required=True)

# 添加命令列參數:source_key(必填),指定來源物件的名稱
parser.add_argument('--source_key', help='The name of the source address for object.', required=True)

# 添加命令列參數:source_bucket(必填),指定源Bucket的名稱
parser.add_argument('--source_bucket', help='The name of the source address for bucket.', required=True)


def main():
    # 解析命令列參數
    args = parser.parse_args()

    # 從環境變數中載入憑證資訊
    # 使用EnvironmentVariableCredentialsProvider從環境變數中讀取Access Key ID和Access Key Secret
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的預設配置
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider  # 設定憑證提供者
    cfg.region = args.region  # 設定Bucket所在的地區
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint  # 如果提供了endpoint,則設定自訂訪問網域名稱

    # 建立OSS用戶端執行個體
    client = oss.Client(cfg)

    # 建立Copier執行個體並執行對象複製操作
    copier = client.copier()

    # 執行對象複製操作
    result = copier.copy(
        oss.CopyObjectRequest(
            bucket=args.bucket,          # 目標Bucket名稱
            key=args.key,                # 目標對象名稱
            source_bucket=args.source_bucket,  # 源Bucket名稱
            source_key=args.source_key   # 來源物件名稱
        )
    )

    # 列印複製結果
    # 使用vars(result)將結果對象轉換為字典格式並列印
    print(vars(result))


if __name__ == "__main__":
    main()

相關文檔

  • 關於使用簡單拷貝方法重新命名檔案的完整範例程式碼,請參見copy_object.py

  • 關於使用拷貝管理器重新命名檔案的完整範例程式碼,請參見copier.py