全部產品
Search

搜尋本產品

    Object Storage Service：Python單連結限速

    文件中心

    Object Storage Service：Python單連結限速

    更新時間：Nov 12, 2024

    本文介紹如何在上傳、下載檔案（Object）時，通過在請求中攜帶限速參數並設定限速值，以保證其他應用的正常頻寬。

    注意事項

    • 本文以華東1（杭州）外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

    • 本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見配置訪問憑證。

    • 本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient，請參見初始化。

    簡單上傳和下載限速

    以下代碼用於簡單上傳和下載檔案時設定單連結限速：

    # -*- coding: utf-8 -*-

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
from oss2.models import OSS_TRAFFIC_LIMIT

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫Object完整路徑，完整路徑中不能包含Bucket名稱，例如exampledir/exampleobject.txt。
object_name = 'exampledir/exampleobject.txt'
# 填寫待上傳的本地檔案的完整路徑，例如D:\\localpath\\examplefile.txt。如果未指定本地路徑，則預設從樣本程式所屬專案對應本地路徑中上傳檔案。
local_file_name = 'D:\\localpath\\examplefile.txt'
# 填寫Object下載到本地檔案的完整路徑。如果指定的本地檔案存在會覆蓋，不存在則建立。
# 如果未指定本地路徑，則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。
down_file_name = 'D:\\localpath\\exampleobject.txt'

# 在headers中設定限速100 KB/s，即819200 bit/s。
limit_speed = (100 * 1024 * 8)
headers = dict()
headers[OSS_TRAFFIC_LIMIT] = str(limit_speed)

# 限速上傳檔案。
result = bucket.put_object_from_file(object_name, local_file_name, headers=headers)
print('http response status:', result.status)

# 限速下載檔案到本地。
result = bucket.get_object_to_file(object_name, down_file_name, headers=headers)
print('http response status:', result.status)

    分區上傳限速

    以下代碼用於分區上傳時設定單連結限速：

    # -*- coding: utf-8 -*-
import os
from oss2 import SizedFileAdapter, determine_part_size
from oss2.headers import OSS_TRAFFIC_LIMIT
from oss2.models import PartInfo
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫不能包含Bucket名稱在內的Object完整路徑，例如exampledir/exampleobject.txt。
key = 'exampledir/exampleobject.txt'
# 填寫本地檔案的完整路徑，例如D:\\localpath\\examplefile.txt。
filename = 'D:\\localpath\\examplefile.txt'

total_size = os.path.getsize(filename)
# determine_part_size方法用於確定分區大小。
part_size = determine_part_size(total_size, preferred_size=100 * 1024)

# 初始化分區。
upload_id = bucket.init_multipart_upload(key).upload_id
parts = []

# 在headers中設定限速100 KB/s，即819200 bit/s。
limit_speed = (100 * 1024 * 8)
headers = dict()
headers[OSS_TRAFFIC_LIMIT] = str(limit_speed)

# 逐個上傳分區。
with open(filename, 'rb') as fileobj:
    part_number = 1
    offset = 0
    while offset < total_size:
        num_to_upload = min(part_size, total_size - offset)
        # 調用SizedFileAdapter(fileobj, size)方法會產生一個新的檔案對象，重新計算起始追加位置。
        result = bucket.upload_part(key, upload_id, part_number,
                                    SizedFileAdapter(fileobj, num_to_upload), headers=headers)
        parts.append(PartInfo(part_number, result.etag))

        offset += num_to_upload
        part_number += 1

# 完成分區上傳。
# 如需在完成分區上傳時設定相關Headers，請參考如下範例程式碼。
headers = dict()
# 設定檔案存取權限ACL。此處設定為OBJECT_ACL_PRIVATE，表示私人許可權。
# headers["x-oss-object-acl"] = oss2.OBJECT_ACL_PRIVATE
bucket.complete_multipart_upload(key, upload_id, parts, headers=headers)
# bucket.complete_multipart_upload(key, upload_id, parts)

# 驗證分區上傳。
with open(filename, 'rb') as fileobj:
    assert bucket.get_object(key).read() == fileobj.read()

    使用簽名URL方式上傳和下載限速

    以下代碼用於使用簽名URL方式上傳、下載檔案時設定單連結限速：

    # -*- coding: utf-8 -*-

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
from oss2.models import OSS_TRAFFIC_LIMIT

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫Object完整路徑，完整路徑中不能包含Bucket名稱，例如exampledir/exampleobject.txt。
object_name = 'exampledir/exampleobject.txt'
# 填寫待上傳的本地檔案的完整路徑，例如D:\\localpath\\examplefile.txt。如果未指定本地路徑，則預設從樣本程式所屬專案對應本地路徑中上傳檔案。
local_file_name = 'D:\\localpath\\examplefile.txt'
# 填寫Object下載到本地檔案的完整路徑。如果指定的本地檔案存在會覆蓋，不存在則建立。
# 如果未指定本地路徑，則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。
down_file_name = 'D:\\localpath\\exampleobject.txt'

# 在params中設定限速100 KB/s，即819200 bit/s。
limit_speed = (100 * 1024 * 8)
params = dict()
params[OSS_TRAFFIC_LIMIT] = str(limit_speed)

# 建立限速上傳檔案的簽名URL, 有效期間60s。
url = bucket.sign_url('PUT', object_name, 60, params=params)
print('put object url:', url)

# 限速上傳。
result = bucket.put_object_with_url_from_file(url, local_file_name)
print('http response status:', result.status)

# 建立限速下載檔案的簽名URL, 有效期間60s。
url = bucket.sign_url('GET', object_name, 60, params=params)
print('get object url:', url)

# 限速下載。
result = bucket.get_object_with_url_to_file(url, down_file_name)
print('http response status:', result.status)

    相關文檔

    關於單連結限速的完整範例程式碼，請參見GitHub樣本。