追加上傳是指通過AppendObject方法在已上傳的追加類型檔案(Appendable Object)末尾直接追加內容。
注意事項
本文以華東1(杭州)外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。
本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見Java配置訪問憑證。
本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient,請參見常見情境配置樣本。
當檔案不存在時,調用AppendObject介面會建立一個追加類型檔案。
當檔案已存在時:
如果檔案為追加類型檔案,且設定的追加位置和檔案當前長度相等,則直接在該檔案末尾追加內容。
如果檔案為追加類型檔案,但是設定的追加位置和檔案當前長度不相等,則拋出PositionNotEqualToLength異常。
如果檔案為非追加類型檔案時,例如通過簡單上傳的檔案類型為Normal的檔案,則拋出ObjectNotAppendable異常。
許可權說明
阿里雲帳號預設擁有全部許可權。阿里雲帳號下的RAM使用者或RAM角色預設沒有任何許可權,需要阿里雲帳號或帳號管理員通過RAM Policy或Bucket Policy授予操作許可權。
API | Action | 說明 |
AppendObject |
| 以追加寫的方式上傳檔案(Object)。 |
| 以追加寫的方式上傳檔案(Object)時,如果通過x-oss-tagging指定Object的標籤,則需要此操作的許可權。 |
範例程式碼
以下代碼用於追加上傳:
const OSS = require('ali-oss')
const client = new OSS({
// yourregion填寫Bucket所在地區。以華東1(杭州)為例,yourRegion填寫為oss-cn-hangzhou。
region: 'yourRegion',
// 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
accessKeyId: process.env.OSS_ACCESS_KEY_ID,
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
authorizationV4: true,
// 填寫Bucket名稱,例如examplebucket。
bucket: 'examplebucket',
});
const headers = {
// 指定Object的存取權限。
'x-oss-object-acl': 'private',
// 指定Object的儲存類型。
'x-oss-storage-class': 'Standard',
// 指定伺服器端加密方式。此處指定為OSS完全託管密鑰進行加密(SSE-OSS)。
'x-oss-server-side-encryption': 'AES256',
};
async function append () {
// 第一次追加上傳。傳回值為下一次追加的位置。
// objectName表示不包含Bucket名稱在內的Object的完整路徑,例如destfolder/examplefile.txt。
// localFile填寫包含尾碼在內的本地檔案完整路徑,例如/users/local/examplefile.txt。
const result = await client.append('objectName', 'localFile'
// 自訂headers和meta。
//,{headers}
)
// 第二次追加。後續追加的位置(position)是追加前檔案的長度(Content-Length)。
result = await client.append('objectName', 'localFile', {
position: result.nextAppendPosition
})
}
append();
相關文檔
關於追加上傳的API介面說明,請參見AppendObject。