全部產品
Search
文件中心

Object Storage Service:傳輸加速(Python SDK V2)

更新時間:Aug 01, 2025

傳輸加速可提升全球各地使用者對OSS的訪問速度,適用於遠距離資料轉送、GB或TB級大檔案上傳和下載的情境。

注意事項

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

方法定義

開啟傳輸加速

put_bucket_transfer_acceleration(request: PutBucketTransferAccelerationRequest, **kwargs) → PutBucketTransferAccelerationResult

查詢傳輸加速狀態

get_bucket_transfer_acceleration(request: GetBucketTransferAccelerationRequest, **kwargs) → GetBucketTransferAccelerationResult

請求參數列表

參數名

類型

說明

request

PutBucketTransferAccelerationRequest

佈建要求參數,具體請參見PutBucketTransferAccelerationRequest

GetBucketTransferAccelerationRequest

佈建要求參數,具體請參見GetBucketTransferAccelerationRequest

傳回值列表

類型

說明

PutBucketTransferAccelerationResult

傳回值,具體請參見PutBucketTransferAccelerationResult

GetBucketTransferAccelerationResult

傳回值,具體請參見GetBucketTransferAccelerationResult

關於開啟傳輸加速方法的完整定義,請參見put_bucket_transfer_acceleration

關於查詢傳輸加速狀態方法的完整定義,請參見get_bucket_transfer_acceleration

範例程式碼

開啟傳輸加速

以下代碼用於開啟Bucket的傳輸加速功能:

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器,並描述指令碼用途:設定儲存空間傳輸加速配置(Transfer Acceleration)
parser = argparse.ArgumentParser(description="put bucket transfer acceleration sample")

# 定義命令列參數,包括必需的地區、儲存空間名稱、endpoint以及是否啟用傳輸加速
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--enabled', help='Whether the transfer acceleration is enabled for this bucket. Default is False.', default=False, type=bool)

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用戶端,準備與OSS互動
    client = oss.Client(cfg)

    # 發送請求以設定指定儲存空間的傳輸加速配置
    result = client.put_bucket_transfer_acceleration(oss.PutBucketTransferAccelerationRequest(
            bucket=args.bucket,  # 儲存空間名
            transfer_acceleration_configuration=oss.TransferAccelerationConfiguration(
                enabled=args.enabled,  # 是否啟用傳輸加速
            ),
    ))

    # 列印操作結果的狀態代碼和請求ID,以便確認請求狀態
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

# 當此指令碼被直接執行時,調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點,控製程序流程從這裡開始

查詢傳輸加速狀態

以下代碼用於查詢Bucket的傳輸加速狀態:

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器,並描述指令碼用途:擷取儲存空間傳輸加速配置(Transfer Acceleration)
parser = argparse.ArgumentParser(description="get bucket transfer acceleration sample")

# 定義命令列參數,包括必需的地區、儲存空間名稱以及endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

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用戶端,準備與OSS互動
    client = oss.Client(cfg)

    # 發送請求以擷取指定儲存空間的傳輸加速配置詳情
    result = client.get_bucket_transfer_acceleration(oss.GetBucketTransferAccelerationRequest(
            bucket=args.bucket,  # 儲存空間名
    ))

    # 列印操作結果的狀態代碼和請求ID,以便確認請求狀態
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' enabled: {result.transfer_acceleration_configuration.enabled if hasattr(result.transfer_acceleration_configuration, "enabled") else "Not set"},'  # 是否啟用了傳輸加速,如果沒有設定則顯示"Not set"
          )

# 當此指令碼被直接執行時,調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點,控製程序流程從這裡開始

相關文檔