有奖捉虫:云通信与企业服务文档专题,速来> HOT

简介

本文档提供关于对象的高级上传、简单上传、分块上传等操作相关的 API 概览以及 SDK 示例代码。
简单操作
API
操作名
操作描述
简单上传对象
上传一个对象至存储桶
表单上传对象
使用表单请求上传对象
分块操作
API
操作名
操作描述
查询分块上传
查询正在进行中的分块上传信息
初始化分块上传
初始化分块上传任务
上传分块
分块上传对象
查询已上传块
查询特定分块上传操作中已上传的块
完成分块上传
完成整个对象的分块上传
终止分块上传
终止一个分块上传操作并删除已上传的块

高级接口(推荐)

该类方法是对上面原生方法的封装,实现了分块上传的全过程,支持并发分块上传,支持断点续传,支持上传任务的取消,暂停和重新开始等。

高级上传

功能说明

Upload File 实现高级上传,传入参数 SliceSize 可以控制文件大小超出一个数值(默认1MB)时自动使用分块上传,否则使用简单上传。

使用示例

const filePath = "temp-file-to-upload" // 本地文件路径
cos.uploadFile({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
FilePath: filePath, /* 必须 */
SliceSize: 1024 * 1024 * 5, /* 触发分块上传的阈值,超过5MB使用分块上传,非必须 */
onTaskReady: function(taskId) { /* 非必须 */
console.log(taskId);
},
onProgress: function (progressData) { /* 非必须 */
console.log(JSON.stringify(progressData));
},
onFileFinish: function (err, data, options) { /* 非必须 */
console.log(options.Key + '上传' + (err ? '失败' : '完成'));
},
// 支持自定义headers 非必须
Headers: {
'x-cos-meta-test': 123
},
}, function(err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
FilePath
上传文件路径
String
SliceSize
表示文件大小超出一个数值时使用分块上传,单位 Byte,默认值1048576(1MB),小于等于该数值会使用 putObject 上传,大于该数值会使用 sliceUploadFile 上传
Number
AsyncLimit
分块的并发量,仅在触发分块上传时有效
Number
StorageClass
对象的存储类型,枚举值:STANDARD、STANDARD_IA、ARCHIVE、DEEP_ARCHIVE 等,更多存储类型请参见 存储类型概述
String
UploadAddMetaMd5
当上传时,给对象的元数据信息增加 x-cos-meta-md5 赋值为对象内容的 MD5 值,格式为 32 位小写字符串。例如:4d00d79b6733c9cc066584a02ed03410
String
CacheControl
RFC 2616中定义的缓存策略,将作为对象的元数据保存
String
ContentDisposition
RFC 2616中定义的文件名称,将作为对象的元数据保存
String
ContentEncoding
RFC 2616中定义的编码格式,将作为对象的元数据保存
String
ContentLength
RFC 2616中定义的 HTTP 请求内容长度(字节)
String
ContentType
RFC 2616中定义的内容类型(MIME),将作为对象的元数据保存
String
Expires
RFC 2616中定义的过期时间,将作为对象的元数据保存
String
Expect
当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容
String
onTaskReady
上传任务创建时的回调函数,返回一个 taskId,唯一标识上传任务,可用于上传任务的取消(cancelTask),停止(pauseTask)和重新开始(restartTask)
Function
- taskId
上传任务的编号
String
onProgress
上传文件的进度回调函数,回调参数为进度对象 progressData
Function
- progressData.loaded
已经上传的文件部分大小,以字节(Bytes)为单位
Number
- progressData.total
整个文件的大小,以字节(Bytes)为单位
Number
- progressData.speed
文件的上传速度,以字节/秒(Bytes/s)为单位
Number
- progressData.percent
文件的上传百分比,以小数形式呈现,例如,上传50%即为0.5
Number
onFileFinish
每个文件完成或错误回调
Function
- err
上传的错误信息
Object
- data
文件完成的信息
Object
- options
当前完成文件的参数信息
Object

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Location
上传完的文件访问地址
String
- Bucket
分块上传的目标存储桶,仅在触发分块上传时返回
String
- Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述,仅在触发分块上传时返回
String
- ETag
合并后文件的唯一 ID,格式:"uuid-<分块数>"
例如"22ca88419e2ed4721c23807c678adbe4c08a7880-3"注意前后携带双引号
String
- VersionId
在开启过版本控制的存储桶中上传对象返回对象的版本 ID,存储桶从未开启则不返回该参数
String

分块上传对象(断点续传)

功能说明

Slice Upload File 可用于实现文件的分块上传,适用于大文件上传。

使用示例

const filePath = "temp-file-to-upload" // 本地文件路径
cos.sliceUploadFile({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
FilePath: filePath, /* 必须 */
onTaskReady: function(taskId) { /* 非必须 */
console.log(taskId);
},
onHashProgress: function (progressData) { /* 非必须 */
console.log(JSON.stringify(progressData));
},
onProgress: function (progressData) { /* 非必须 */
console.log(JSON.stringify(progressData));
},
// 支持自定义headers 非必须
Headers: {
'x-cos-meta-test': 123
},
}, function(err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
FilePath
上传文件路径
String
SliceSize
分块大小
Number
AsyncLimit
分块的并发量
Number
StorageClass
对象的存储类型,枚举值:STANDARD、STANDARD_IA、ARCHIVE 等,更多存储类型请参见 存储类型概述 文档
String
CacheControl
RFC 2616中定义的缓存策略,将作为对象的元数据保存
String
ContentDisposition
RFC 2616中定义的文件名称,将作为对象的元数据保存
String
ContentEncoding
RFC 2616中定义的编码格式,将作为对象的元数据保存
String
ContentLength
RFC 2616中定义的 HTTP 请求内容长度(字节)
String
ContentType
RFC 2616中定义的内容类型(MIME),将作为对象的元数据保存
String
Expires
RFC 2616中定义的过期时间,将作为对象的元数据保存
String
Expect
当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容
String
onTaskReady
上传任务创建时的回调函数,返回一个 taskId,唯一标识上传任务,可用于上传任务的取消(cancelTask),停止(pauseTask)和重新开始(restartTask)
Function
- taskId
上传任务的编号
String
onHashProgress
计算文件 MD5 值的进度回调函数,回调参数为进度对象 progressData
Function
- progressData.loaded
已经校验的文件部分大小,以字节(Bytes)为单位
Number
- progressData.total
整个文件的大小,以字节(Bytes)为单位
Number
- progressData.speed
文件的校验速度,以字节/秒(Bytes/s)为单位
Number
- progressData.percent
文件的校验百分比,以小数形式呈现,例如:校验50%即为0.5
Number
onProgress
上传文件的进度回调函数,回调参数为进度对象 progressData
Function
- progressData.loaded
已经上传的文件部分大小,以字节(Bytes)为单位
Number
- progressData.total
整个文件的大小,以字节(Bytes)为单位
Number
- progressData.speed
文件的上传速度,以字节/秒(Bytes/s)为单位
Number
- progressData.percent
文件的上传百分比,以小数形式呈现,例如:上传50%即为0.5
Number

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Location
创建对象的外网访问域名
String
- Bucket
分块上传的目标存储桶
String
- Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
- ETag
合并后文件的唯一 ID,格式:"uuid-<分块数>"
例如"22ca88419e2ed4721c23807c678adbe4c08a7880-3"注意前后携带双引号
String
- VersionId
在开启过版本控制的存储桶中上传对象返回对象的版本 ID,存储桶从未开启则不返回该参数
String

批量上传

功能说明

方法一: 批量上传可以直接多次调用 putObject 和 sliceUploadFile,达到批量上传效果。通过实例化参数 FileParallelLimit 控制文件并发数,默认3个并发。
方法二: 可以调用 cos.uploadFiles 实现批量上传,传入参数 SliceSize 可以控制文件大小超出一个数值时使用分块上传。以下是 uploadFiles 方法说明。

方法原型

调用 uploadFiles 操作:
const filePath1 = "temp-file-to-upload" // 本地文件路径
const filePath2 = "temp-file-to-upload" // 本地文件路径
cos.uploadFiles({
files: [{
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
FilePath: filePath1,
onTaskReady: function(taskId) {
/* taskId 可通过队列操作来取消上传 cos.cancelTask(taskId)、停止上传 cos.pauseTask(taskId)、重新开始上传 cos.restartTask(taskId) */
console.log(taskId);
},
// 支持自定义headers 非必须
Headers: {
'x-cos-meta-test': 123
},
}, {
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '2.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
FilePath: filePath2,
onTaskReady: function(taskId) {
/* taskId 可通过队列操作来取消上传 cos.cancelTask(taskId)、停止上传 cos.pauseTask(taskId)、重新开始上传 cos.restartTask(taskId) */
console.log(taskId);
},
// 支持自定义headers 非必须
Headers: {
'x-cos-meta-test': 123
},
}],
SliceSize: 1024 * 1024 * 10, /* 设置大于10MB采用分块上传 */
onProgress: function (info) {
var percent = parseInt(info.percent * 10000) / 100;
var speed = parseInt(info.speed / 1024 / 1024 * 100) / 100;
console.log('进度:' + percent + '%; 速度:' + speed + 'Mb/s;');
},
onFileFinish: function (err, data, options) {
console.log(options.Key + '上传' + (err ? '失败' : '完成'));
},
}, function (err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
files
文件列表,每一项是传给 putObject 和 sliceUploadFile 的参数对象
Object
- Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
- Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
- Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
- FilePath
上传文件路径
String
- CacheControl
RFC 2616中定义的缓存策略,将作为对象的元数据保存
String
- ContentDisposition
RFC 2616中定义的文件名称,将作为对象的元数据保存
String
- ContentEncoding
RFC 2616中定义的编码格式,将作为对象的元数据保存
String
- ContentLength
RFC 2616中定义的 HTTP 请求内容长度(字节)
String
- ContentType
RFC 2616中定义的内容类型(MIME),将作为对象的元数据保存
String
- Expires
RFC 2616中定义的过期时间,将作为对象的元数据保存
String
- Expect
当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容
String
- onTaskReady
上传任务创建时的回调函数,返回一个 taskId,唯一标识上传任务,可用于上传任务的取消(cancelTask),停止(pauseTask)和重新开始(restartTask)
Function
-- taskId
上传任务的编号
String
SliceSize
表示文件大小超出一个数值时使用分块上传,单位 Byte,默认值1048576(1MB),小于等于该数值会使用 putObject 上传,大于该数值会使用 sliceUploadFile 上传
Number
onProgress
所有任务 进度汇总计算出来的上传进度
String
- progressData.loaded
已经上传的文件部分大小,以字节(Bytes)为单位
Number
- progressData.total
整个文件的大小,以字节(Bytes)为单位
Number
- progressData.speed
文件的上传速度,以字节/秒(Bytes/s)为单位
Number
- progressData.percent
文件的上传百分比,以小数形式呈现,例如:上传50%即为0.5
Number
onFileFinish
每个文件完成或错误回调
Function
- err
上传的错误信息
Object
- data
文件完成的信息
Object
- options
当前完成文件的参数信息
Object

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- files
每个文件的 error 或 data
ObjectArray
- - error
上传的错误信息
Object
- - data
文件完成的信息
Object
- - options
当前完成文件的参数信息
Object

上传队列

Node.js SDK 针对 putObject 和 sliceUploadFile 发起的上传任务都有记录队列里,队列相关方法如下。
1. var taskList = cos.getTaskList() 可以获取任务列表。
2. cos.pauseTask()、cos.restartTask()、cos.cancelTask() 操作任务。
3. cos.on('list-update', callback); 可以监听列表和进度变化。
完整的队列使用示例请参见 demo-queue

取消上传任务

根据 taskId 取消上传任务。
使用示例
var taskId = 'xxxxx'; /* 必须 */
cos.cancelTask(taskId);
参数说明
参数名
参数描述
类型
是否必填
taskId
文件上传任务的编号,在调用 sliceUploadFile 方法时,其 TaskReady 回调会返回该上传任务的 taskId
String

暂停上传任务

根据 taskId 暂停上传任务。
使用示例
var taskId = 'xxxxx'; /* 必须 */
cos.pauseTask(taskId);
参数说明
参数名
参数描述
类型
是否必填
taskId
文件上传任务的编号,在调用 sliceUploadFile 方法时,其 TaskReady 回调会返回该上传任务的 taskId
String

重启上传任务

根据 taskId 重新开始上传任务,可以用于开启用户手动停止的(调用 pauseTask 停止)或者因为上传错误而停止的上传任务。
使用示例
var taskId = 'xxxxx'; /* 必须 */
cos.restartTask(taskId);
参数说明
参数名
参数描述
类型
是否必填
taskId
文件上传任务的编号,在调用 sliceUploadFile 方法时,其 TaskReady 回调会返回该上传任务的 taskId
String

简单操作

简单上传对象

功能说明

PUT Object 接口可以上传一个对象至指定存储桶中,该操作需要请求者对存储桶有 WRITE 权限。最大支持上传不超过5GB的对象,5GB以上对象请使用 分块上传高级接口 上传。
注意
Key(文件名)不能以/结尾,否则会被识别为文件夹。
Key(文件名)同名上传默认为覆盖操作。若您未开启版本控制且不想覆盖云上文件时,请确保上传时的Key不重复。
每个主账号(即同一个 APPID),存储桶的 ACL 规则数量最多为1000条,对象 ACL 规则数量不限制。如果您不需要进行对象 ACL 控制,请在上传时不要设置,默认继承存储桶权限。
上传之后,您可以用同样的 Key 生成预签名链接(下载请指定 method 为 GET,具体接口说明见下文),分享到其他端来进行下载。但注意如果您的文件是私有读权限,那么预签名链接只有一定的有效期。

使用示例

简单上传文件,适用于小文件上传。
const filePath = "temp-file-to-upload" // 本地文件路径
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
StorageClass: 'STANDARD',
/* 当 Body 为 stream 类型时,ContentLength 必传,否则 onProgress 不能返回正确的进度信息 */
Body: fs.createReadStream(filePath), // 上传文件对象
ContentLength: fs.statSync(filePath).size,
onProgress: function(progressData) {
console.log(JSON.stringify(progressData));
}
}, function(err, data) {
console.log(err || data);
});
上传 Buffer 作为文件内容:
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.txt', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
Body: Buffer.from('hello!'), /* 必须 */
}, function(err, data) {
console.log(err || data);
});
上传字符串作为文件内容:
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.txt', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
Body: 'hello!',
}, function(err, data) {
console.log(err || data);
});
上传 base64作为文件内容:
var base64Url = 'data:image/png;base64,iVBORw0KGgo.....';
// 需要转为 Buffer上传
var body = Buffer.from(base64Url.split(',')[1] , 'base64');
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 必须 */
Region: 'COS_REGION', /* 必须 */
Key: '1.png', /* 必须 */
Body: body,
}, function(err, data) {
console.log(err || data);
});
创建目录 a:
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: 'a/', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
Body: '',
}, function(err, data) {
console.log(err || data);
});
自定义Headers:
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 必须 */
Region: 'ap-beijing', /* 必须 */
Key: 'a', /* 必须 */
Body: 'hello', /* 必须 */
// 支持自定义headers 非必须
Headers: {
'x-cos-meta-test': 123
},
}, function(err, data) {
console.log(err || data);
});
上传文件到指定目录 a/b:
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: 'a/b/1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
Body: fileObject, // 上传文件对象
onProgress: function(progressData) {
console.log(JSON.stringify(progressData));
}
}, function(err, data) {
console.log(err || data);
});
上传对象(单链接限速):
说明
关于上传对象的限速说明,请参见 单链接限速
cos.putObject({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
StorageClass: 'STANDARD',
Body: fileObject, // 上传文件对象
Headers: {
'x-cos-traffic-limit': 819200, // 限速值设置范围为819200 - 838860800,单位默认为 bit/s,即800Kb/s - 800Mb/s,如果超出该范围将返回400错误。
},
onProgress: function(progressData) {
console.log(JSON.stringify(progressData));
}
}, function(err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
Body
上传文件的内容,可以为 FileStream、字符串、Buffer
Stream/Buffer/String
CacheControl
RFC 2616中定义的缓存策略,将作为对象的元数据保存
String
ContentDisposition
RFC 2616中定义的文件名称,将作为对象的元数据保存
String
ContentEncoding
RFC 2616中定义的编码格式,将作为对象的元数据保存
String
ContentLength
RFC 2616中定义的 HTTP 请求内容长度(字节),当 Body 为 Stream 类型时,ContentLength 必填
String
ContentType
RFC 2616中定义的内容类型(MIME),将作为对象的元数据保存
String
Expires
RFC 2616中定义的过期时间,将作为对象的元数据保存,过期后仅代表缓存失效,文件不会被删除
String
Expect
当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容
String
ACL
定义对象的访问控制列表(ACL)属性,枚举值请参见 ACL 概述 文档中对象的预设 ACL 部分,例如 default,private,public-read 等
注意:如果您不需要进行对象 ACL 控制,请设置为 default 或者此项不进行设置,默认继承存储桶权限
String
GrantRead
赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者:
当需要给子账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>"
当需要给主账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" 例如'id="qcs::cam::uin/100000000001:uin/100000000001",id="qcs::cam::uin/100000000001:uin/100000000011"'
String
GrantReadAcp
赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者:
当需要给子账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>"
当需要给主账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>"
例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"'
String
GrantWriteAcp
赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者:
当需要给子账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>"
当需要给主账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>"
例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"'
String
GrantFullControl
赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者:
当需要给子账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>"
当需要给主账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>"
例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"'
String
StorageClass
设置对象的存储类型,枚举值:STANDARD、STANDARD_IA、ARCHIVE 等,更多存储类型请参见 存储类型概述 文档。默认值:STANDARD
String
x-cos-meta-*
允许用户自定义的头部信息,将作为对象的元数据保存,大小限制2KB
String
onTaskReady
上传任务创建时的回调函数,返回一个 taskId,唯一标识上传任务,可用于上传任务的取消(cancelTask),停止(pauseTask)和重新开始(restartTask)
Function
- taskId
上传任务的编号
String
onProgress
进度的回调函数,进度回调响应对象(progressData)属性如下
Function
- progressData.loaded
已经上传的文件部分大小,以字节(Bytes)为单位
Number
- progressData.total
整个文件的大小,以字节(Bytes)为单位
Number
- progressData.speed
文件的上传速度,以字节/秒(Bytes/s)为单位
Number
- progressData.percent
文件上传的百分比,以小数形式呈现,例如:上传50%即为0.5
Number

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- ETag
返回文件的 MD5 算法校验值。ETag 的值可以用于检查对象在上传过程中是否有损坏
例如"09cba091df696af91549de27b8e7d0f6"注意:这里的 ETag 值字符串前后带有双引号
String
- Location
创建对象的外网访问域名
String
- VersionId
在开启过版本控制的存储桶中上传对象返回对象的版本 ID,存储桶从未开启则不返回该参数
String


表单上传对象

Node.js SDK 未提供 POST Object 接口对应的方法,如果需要使用该接口,请参见 Web 端直传实践 里的“方案 B:使用 Form 表单上传”。

分块操作

关于分块上传的更多说明请参见 分块上传。分块上传对象可包括的操作如下:
分块上传对象:初始化分块上传,上传分块,完成所有分块上传。
分块续传:查询已上传的分块,上传分块,完成所有分块上传。
删除已上传分块。

查询分块上传

功能说明

List Multipart Uploads 用来查询正在进行中的分块上传信息。单次最多列出1000个正在进行中的分块上传。

使用示例

获取前缀为 a 的未完成的 UploadId 列表,示例如下:
cos.multipartList({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Prefix: 'a', /* 非必须 */
}, function(err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Prefix
对象键前缀匹配,限定返回中只包含指定前缀的对象键。注意使用 prefix 查询时,返回的对象键 中仍会包含 Prefix
String
Delimiter
定界符为一个分隔符号,用于对对象键进行分组。一般是传/。所有对象键从 Prefix 或从头(如未指定 Prefix)到首个 delimiter 之间相同部分的路径归为一类,定义为 Common Prefix,然后列出所有 Common Prefix
String
EncodingType
规定返回值的编码格式,合法值:url
String
MaxUploads
设置最大返回的条目数量,合法取值为1 - 1000,默认1000
String
KeyMarker
与 upload-id-marker 一起使用
当 upload-id-marker 未被指定时:  - ObjectName 字母顺序大于 key-marker 的条目将被列出
当 upload-id-marker 被指定时:  - ObjectName 字母顺序大于 key-marker 的条目被列出  - ObjectName 字母顺序等于 key-marker 且 UploadID 大于 upload-id-marker 的条目将被列出
String
UploadIdMarker
与 key-marker 一起使用
当 key-marker 未被指定时:  - upload-id-marker 将被忽略
当 key-marker 被指定时:  - ObjectName 字母顺序大于 key-marker 的条目被列出  - ObjectName 字母顺序等于 key-marker 且 UploadID 大于 upload-id-marker 的条目将被列出
String

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Bucket
分块上传的目标存储桶
String
- Encoding-Type
规定返回值的编码格式,合法值:url
String
- KeyMarker
列出条目从该 key 值开始
String
- UploadIdMarker
列出条目从该 UploadId 值开始
String
- NextKeyMarker
假如返回条目被截断,则返回 NextKeyMarker 就是下一个条目的起点
String
- NextUploadIdMarker
假如返回条目被截断,则返回 UploadId 就是下一个条目的起点
String
- MaxUploads
设置最大返回的条目数量,合法取值范围为1 - 1000
String
- IsTruncated
返回条目是否被截断,'true' 或者 'false'
String
- Prefix
对象键前缀匹配,限定返回中只包含指定前缀的对象键。
String
- Delimiter
定界符为一个分隔符号,用于对对象键进行分组。一般是传/。所有对象键从 Prefix 或从头(如未指定 Prefix)到首个 delimiter 之间相同部分的路径归为一类,定义为 Common Prefix,然后列出所有 Common Prefix
String
- CommonPrefixs
将 prefix 到 delimiter 之间的相同路径归为一类,定义为 Common Prefix
ObjectArray
- - Prefix
显示具体的 Common Prefixs
String
- Upload
分块上传的信息集合
ObjectArray
- - Key
对象的名称,即对象键
String
- - UploadId
表示本次分块上传的 ID
String
- - StorageClass
用于表示分块的存储类型,枚举值:STANDARD、STANDARD_IA、ARCHIVE 等,更多存储类型请参见 存储类型概述 文档
String
- - Initiator
用于表示本次上传发起者的信息
Object
- - - DisplayName
上传发起者的名称
String
- - - ID
上传发起者 ID,格式:qcs::cam::uin/<OwnerUin>:uin/<SubUin>
如果是主账号,<OwnerUin> 和 <SubUin> 是同一个值
String
- - Owner
表示这些分块持有者的信息
Object
- - - DisplayName
分块持有者的名称
String
- - - ID
分块持有者 ID,格式:qcs::cam::uin/<OwnerUin>:uin/<SubUin>
如果是主账号,<OwnerUin> 和 <SubUin> 是同一个值
String
- - Initiated
分块上传的起始时间
String

初始化分块上传

功能说明

Initiate Multipart Uploads 请求实现初始化分块上传,成功执行此请求后会返回 Upload ID ,用于后续的 Upload Part 请求。

使用示例

cos.multipartInit({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
}, function(err, data) {
console.log(err || data);
if (data) {
uploadId = data.UploadId;
}
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
CacheControl
RFC 2616 中定义的缓存策略,将作为对象的元数据保存
String
ContentDisposition
RFC 2616 中定义的文件名称,将作为对象的元数据保存
String
ContentEncoding
RFC 2616 中定义的编码格式,将作为对象的元数据保存
String
ContentType
RFC 2616 中定义的内容类型(MIME),将作为对象的元数据保存
String
Expires
RFC 2616 中定义的过期时间,将作为对象的元数据保存,过期后仅代表缓存失效,文件不会被删除
String
ACL
定义对象的访问控制列表(ACL)属性,枚举值请参见 ACL 概述 文档中对象的预设 ACL 部分,如 default,private,public-read 等
注意:如果您不需要进行对象 ACL 控制,请设置为 default 或者此项不进行设置,默认继承存储桶权限
String
GrantRead
赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者:
当需要给子账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>"
当需要给主账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" 例如'id="qcs::cam::uin/100000000001:uin/100000000001",id="qcs::cam::uin/100000000001:uin/100000000011"'
String
GrantFullControl
赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者:
当需要给子账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>"
当需要给主账号授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" 例如 'id="qcs::cam::uin/100000000001:uin/100000000001",id="qcs::cam::uin/100000000001:uin/100000000011"'
String
StorageClass
设置对象的存储类型,枚举值:STANDARD、STANDARD_IA、ARCHIVE 等,更多存储类型请参见 存储类型概述 文档。默认值:STANDARD
String
x-cos-meta-*
允许用户自定义的头部信息,将作为对象的元数据返回。大小限制2KB
String

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
Bucket
分块上传的目标存储桶,格式为 BucketName-APPID,例如 examplebucket-1250000000
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
UploadId
在后续上传中使用的 ID
String

上传分块

功能说明

Upload Part 接口请求实现在初始化以后的分块上传,支持的块的数量为1 - 10000,块的大小为1MB - 5GB。
分块上传首先要进行初始化,用 Initiate Multipart Upload 接口初始化分块上传,得到一个 uploadId,该 ID 不但唯一标识这一分块数据,也标识了这分块数据在整个文件内的相对位置。
在每次请求 Upload Part 时候,需要携带 partNumber 和 uploadId,partNumber 为块的编号,支持乱序上传。
当传入 uploadId 和 partNumber 都相同的时候,后传入的块将覆盖之前传入的块。当 uploadId 不存在时会返回404错误,错误码为 NoSuchUpload。

使用示例

const filePath = "temp-file-to-upload" // 本地文件路径
cos.multipartUpload({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
ContentLength: '1024',
UploadId: 'exampleUploadId',
PartNumber: 1,
Body: fs.createReadStream(filePath)
}, function(err, data) {
console.log(err || data);
if (data) {
eTag = data.ETag;
}
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
ContentLength
RFC 2616 中定义的 HTTP 请求内容长度(字节)
String
PartNumber
分块的编号
Number
UploadId
本次分块上传任务的编号
String
Body
上传文件分块的内容,可以为字符串,File 对象或者 Blob 对象
String\\File\\Blob
Expect
RFC 2616 中定义的 HTTP 请求内容长度(字节)。当使用Expect: 100-continue时,在收到服务端确认后,才会发送请求内容
String
ContentMD5
RFC 1864中定义的经过 Base64 编码的128-bit内容 MD5 校验值,此头部用来校验文件内容是否发生变化
String

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object

查询已上传块

功能说明

List Parts 用来查询特定分块上传中的已上传的块,即列出指定 UploadId 所属的所有已上传成功的分块。

使用示例

cos.multipartListPart({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
UploadId: 'exampleUploadId', /* 必须 */
}, function(err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
UploadId
标识本次分块上传的 ID,使用 Initiate Multipart Upload 接口初始化分块上传时得到的 UploadId
String
EncodingType
规定返回值的编码方式
String
MaxParts
单次返回最大的条目数量,默认为1000
String
PartNumberMarker
默认以 UTF-8 二进制顺序列出条目,所有列出条目从 marker 开始
String

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Bucket
分块上传的目标存储桶
String
- Encoding-type
规定返回值的编码方式
String
- Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
- UploadId
标识本次分块上传的 ID,使用 Initiate Multipart Upload 接口初始化分块上传时得到的 UploadId
String
- Initiator
用来表示本次上传发起者的信息
Object
- - DisplayName
上传发起者的名称
String
- - ID
上传发起者 ID,格式:qcs::cam::uin/<OwnerUin>:uin/<SubUin> <br>如果是主账号,&lt;OwnerUin> 和 &lt;SubUin> 是同一个值
String
- Owner
用来表示这些分块所有者的信息
Object
- - DisplayName
存储桶持有者的名称
String
- - ID
存储桶持有者 ID,一般为用户的 UIN
String
- StorageClass
用于表示这些分块的存储级别,枚举值:STANDARD、STANDARD_IA、ARCHIVE 等,更多存储类型请参见 存储类型概述 文档
String
- PartNumberMarker
默认以 UTF-8 二进制顺序列出条目,所有列出条目从 marker 开始
String
- NextPartNumberMarker
假如返回条目被截断,则返回 NextMarker 就是下一个条目的起点
String
- MaxParts
单次返回最大的条目数量
String
- IsTruncated
返回条目是否被截断,'true' 或者 'false'
String
- Part
分块信息列表
ObjectArray
- - PartNumber
块的编号
String
- - LastModified
块最后修改时间
String
- - ETag
块的 MD5 算法校验值
String
- - Size
块大小,单位为 Byte
String

完成分块上传

功能说明

Complete Multipart Upload 接口请求用来实现完成整个分块上传。当使用 Upload Parts 上传完所有块以后,必须调用该 API 来完成整个文件的分块上传。在使用该 API 时,您必须在请求 Body 中给出每一个块的 PartNumber 和 ETag,用来校验块的准确性。 由于分块上传完后需要合并,而合并需要数分钟时间,因而当合并分块开始的时候,COS 就立即返回200的状态码,在合并的过程中,COS 会周期性的返回空格信息来保持连接活跃,直到合并完成,COS 会在 Body 中返回合并后块的内容。

当上传块小于1MB ,在调用该 API 时,会返回400 EntityTooSmall。
当上传块编号不连续,在调用该 API 时,会返回400 InvalidPart。
当请求 Body 中的块信息未按序号从小到大排列,在调用该 API 时,会返回400 InvalidPartOrder。
当 UploadId 不存在,在调用该 API 时,会返回404 NoSuchUpload。
注意:
建议您及时完成分块上传或者舍弃分块上传,因为已上传但是未终止的块会占用存储空间进而产生存储费用。

使用示例

cos.multipartComplete({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
UploadId: 'exampleUploadId', /* 必须 */
Parts: [
{PartNumber: 1, ETag: 'exampleETag'},
]
}, function(err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
UploadId
上传任务编号
String
Parts
用来说明本次分块上传中块的信息列表
ObjectArray
- PartNumber
分块的编号
Number
- ETag
每个块文件的 MD5 算法校验值<br>例如"22ca88419e2ed4721c23807c678adbe4c08a7880"注意前后携带双引号
String

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Location
创建对象的外网访问域名
String
- Bucket
分块上传的目标存储桶
String
- Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
- ETag
合并后文件的唯一 ID,格式:"uuid-<分块数>"<br>例如"22ca88419e2ed4721c23807c678adbe4c08a7880-3"注意前后携带双引号
String

终止分块上传

功能说明

Abort Multipart Upload 用来实现终止一个分块上传操作并删除已上传的块。当您调用 Abort Multipart Upload 时,如果有正在使用这个 UploadId 上传块的请求,则 Upload Parts 会返回失败。当该 UploadId 不存在时,会返回404 NoSuchUpload。
注意:
建议您及时完成分块上传或者舍弃分块上传,因为已上传但是未终止的块会占用存储空间进而产生存储费用。

使用示例

cos.multipartAbort({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '1.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
UploadId: 'exampleUploadId' /* 必须 */
}, function(err, data) {
console.log(err || data);
});

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
String
UploadId
标识本次分块上传的 ID,使用 Initiate Multipart Upload 接口初始化分块上传时得到的 UploadId
String

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object