默認情況下,如果新添加文件與現有文件(Object)同名且對該文件有訪問權限,則新添加的文件將覆蓋原有的文件。本文介紹如何通過設置請求頭x-oss-forbid-overwrite在簡單上傳、拷貝文件及分片上傳等場景中禁止覆蓋同名文件。
注意事項
簡單上傳
以下代碼用于簡單上傳時禁止覆蓋同名文件:
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變量中獲取訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# 填寫Bucket所在地域對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
# yourBucketName填寫存儲空間名稱。
bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
# 上傳文件。
# 指定PutObject操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時,默認覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時,表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時,表示禁止覆蓋同名Object,如果同名Object已存在,程序將報錯。
headers = {'x-oss-forbid-overwrite':'true'}
result = bucket.put_object('yourObjectName', 'content of object', headers=headers)
# HTTP返回碼。
print('http status: {0}'.format(result.status))
# 請求ID。請求ID是請求的唯一標識,強烈建議在程序日志中添加此參數。
print('request_id: {0}'.format(result.request_id))
# ETag是put_object方法返回值特有的屬性。
print('ETag: {0}'.format(result.etag))
# HTTP響應頭部。
print('date: {0}'.format(result.headers['date']))
拷貝文件
拷貝小文件
以下代碼用于拷貝小文件時禁止覆蓋同名文件:
# -*- coding: utf-8 -*- import oss2 from oss2.credentials import EnvironmentVariableCredentialsProvider # 從環境變量中獲取訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider()) # 填寫Bucket所在地域對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。 # yourBucketName填寫存儲空間名稱。 bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName') # 指定copy_object操作時是否覆蓋同名Object。 # 不指定x-oss-forbid-overwrite時,默認覆蓋同名Object。 # 指定x-oss-forbid-overwrite為false時,表示允許覆蓋同名Object。 # 指定x-oss-forbid-overwrite為true時,表示禁止覆蓋同名Object,如果同名Object已存在,程序將報錯。 headers = dict() headers = {'x-oss-forbid-overwrite':'true'} bucket.copy_object('yourSourceBucketName', 'yourSourceObjectName', 'yourDestinationObjectName', headers=headers)
拷貝大文件
以下代碼用于拷貝大文件(分片拷貝)時禁止覆蓋同名文件:
# -*- coding: utf-8 -*- import oss2 from oss2.credentials import EnvironmentVariableCredentialsProvider from oss2.models import PartInfo from oss2 import determine_part_size # 從環境變量中獲取訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider()) # 填寫Bucket所在地域對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。 # yourBucketName填寫存儲空間名稱。 bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName') src_object = 'yourSourceObjectName' dst_object = 'yourDestinationObjectName' total_size = bucket.head_object(src_object).content_length part_size = determine_part_size(total_size, preferred_size=100 * 1024) # 初始化分片。 # 指定拷貝文件操作時是否覆蓋同名Object。 # 不指定x-oss-forbid-overwrite時,默認覆蓋同名Object。 # 指定x-oss-forbid-overwrite為false時,表示允許覆蓋同名Object。 # 指定x-oss-forbid-overwrite為true時,表示禁止覆蓋同名Object,如果同名Object已存在,程序將報錯。 headers = dict() headers = {'x-oss-forbid-overwrite':'true'} upload_id = bucket.init_multipart_upload(dst_object, headers=headers).upload_id parts = [] # 逐個分片拷貝。 part_number = 1 offset = 0 while offset < total_size: num_to_upload = min(part_size, total_size - offset) byte_range = (offset, offset + num_to_upload - 1) result = bucket.upload_part_copy(bucket.bucket_name, src_object, byte_range,dst_object, upload_id, part_number) parts.append(PartInfo(part_number, result.etag)) offset += num_to_upload part_number += 1 # 完成分片拷貝。 # 指定拷貝文件操作時是否覆蓋同名Object。 # 不指定x-oss-forbid-overwrite時,默認覆蓋同名Object。 # 指定x-oss-forbid-overwrite為false時,表示允許覆蓋同名Object。 # 指定x-oss-forbid-overwrite為true時,表示禁止覆蓋同名Object,如果同名Object已存在,程序將報錯。 headers = dict() headers = {'x-oss-forbid-overwrite':'true'} bucket.complete_multipart_upload(dst_object, upload_id, parts, headers=headers)
分片上傳
以下代碼用于分片上傳時禁止覆蓋同名文件:
# -*- coding: utf-8 -*-
import os
from oss2 import SizedFileAdapter, determine_part_size
from oss2.models import PartInfo
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變量中獲取訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# 填寫Bucket所在地域對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
# yourBucketName填寫存儲空間名稱。
bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
key = 'yourObjectName'
filename = 'yourLocalFile'
total_size = os.path.getsize(filename)
# determine_part_size方法用來確定分片大小。
part_size = determine_part_size(total_size, preferred_size=100 * 1024)
# 初始化分片。
# 指定分片上傳操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時,默認覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時,表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時,表示禁止覆蓋同名Object,如果同名Object已存在,程序將報錯。
headers = {'x-oss-forbid-overwrite':'true'}
upload_id = bucket.init_multipart_upload(key, headers=headers).upload_id
parts = []
# 逐個上傳分片。
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))
parts.append(PartInfo(part_number, result.etag))
offset += num_to_upload
part_number += 1
# 完成分片上傳。
# 指定分片上傳操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時,默認覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時,表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時,表示禁止覆蓋同名Object,如果同名Object已存在,程序將報錯。
headers = {'x-oss-forbid-overwrite':'true'}
bucket.complete_multipart_upload(key, upload_id, parts, headers=headers)
# 驗證分片上傳。
with open(filename, 'rb') as fileobj:
assert bucket.get_object(key).read() == fileobj.read()
相關文檔
關于簡單上傳的API接口說明,請參見PutObject。
關于拷貝文件的API接口說明,請參見CopyObject。
關于分片上傳的API接口說明,請參見InitiateMultipartUpload以及CompleteMultipartUpload。
文檔內容是否對您有幫助?