本文介紹如何快速使用OSS Python SDK完成常見操作,如建立儲存空間(Bucket)、上傳檔案(Object)、下載檔案等。
操作視頻
觀看以下視頻快速瞭解如何快速使用Python SDK。
建立儲存空間
儲存空間是OSS的全域命名空間,相當於資料的容器,可以儲存若干檔案。
說明
關於擷取Endpoint的更多資訊,請參見OSS訪問網域名稱、資料中心、開放連接埠。關於儲存空間的命名規範的更多資訊,請參見基本概念。
以下代碼用於建立儲存空間。
# -*- coding: utf-8 -*-
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"
# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# 設定儲存空間為私人讀寫權限。
bucket.create_bucket(oss2.models.BUCKET_ACL_PRIVATE)
關於建立儲存空間的更多資訊,請參見建立儲存空間。
上傳檔案
以下代碼用於通過流式上傳的方式將檔案上傳到OSS。
# -*- coding: utf-8 -*-
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"
# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# 上傳檔案到OSS。
# yourObjectName由包含檔案尾碼,不包含Bucket名稱組成的Object完整路徑,例如abc/efg/123.jpg。
# yourLocalFile由本地檔案路徑加檔案名稱包括尾碼組成,例如/users/local/myfile.txt。
bucket.put_object_from_file('yourObjectName', 'yourLocalFile')
下載檔案
以下代碼用於將指定的OSS檔案下載到本地檔案:
# -*- coding: utf-8 -*-
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"
# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# 下載OSS檔案到本地檔案。
# yourObjectName由包含檔案尾碼,不包含Bucket名稱組成的Object完整路徑,例如abc/efg/123.jpg。
# yourLocalFile由本地檔案路徑加檔案名稱包括尾碼組成,例如/users/local/myfile.txt。
bucket.get_object_to_file('yourObjectName', 'yourLocalFile')
列舉檔案
以下代碼用於列舉指定儲存空間下的10個檔案:
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
from itertools import islice
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數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"
# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# oss2.ObjectIterator用於遍曆檔案。
for b in islice(oss2.ObjectIterator(bucket), 10):
print(b.key)
刪除檔案
以下代碼用於刪除指定檔案。
# -*- coding: utf-8 -*-
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"
# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# yourObjectName表示刪除OSS檔案時需要指定包含檔案尾碼,不包含Bucket名稱在內的完整路徑,例如abc/efg/123.jpg。
bucket.delete_object('yourObjectName')
刪除檔案詳情請參見管理檔案中的刪除檔案。