追加上传是指通过AppendObject方法在已上传的追加类型文件(Appendable Object)末尾直接追加内容。
注意事项
本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS访问域名、数据中心、开放端口。
本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见Java配置访问凭证。
本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见新建OSSClient。
要追加上传,您必须有
oss:PutObject
权限。具体操作,请参见为RAM用户授权自定义的权限策略。当文件不存在时,调用AppendObject接口会创建一个追加类型文件。
当文件已存在时:
如果文件为追加类型文件,且设置的追加位置和文件当前长度相等,则直接在该文件末尾追加内容。
如果文件为追加类型文件,但是设置的追加位置和文件当前长度不相等,则抛出PositionNotEqualToLength异常。
如果文件为非追加类型文件时,例如通过简单上传的文件类型为Normal的文件,则抛出ObjectNotAppendable异常。
示例代码
以下代码用于追加上传:
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。