列举分段上传任务
功能说明
列举指定桶中所有的初始化后还未合并或还未取消的分段上传任务。
通过列举桶中的多段上传任务,您可以获得已初始化多段上传任务的列表,已初始化多段上传任务是指初始化后还未合并以及未取消的多段上传任务。每个请求将返回最多1000个多段上传任务,如果正在进行的多段上传任务超过1000个,您需要发送其他请求以检索剩余的多段上传任务。
开发过程中,您有任何问题可以在github上提交issue,或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。
接口约束
- 您必须是桶拥有者或拥有列举分段上传任务的权限,才能列举分段上传任务。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:ListBucketMultipartUploads权限,如果使用桶策略则需授予ListBucketMultipartUploads权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
- 默认情况下,允许桶所有者和多段上传任务的发起者执行此操作。除了默认情况之外,桶所有者可以允许其他委托人对桶执行ListBucketMultipartUploads操作。
方法定义
ObsClient.listMultipartUploads(params)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | String | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| Status | String | 可选 | 参数解释: 桶的跨区域复制配置。 取值范围:
默认取值: 无 |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
| Status | number | 参数解释: OBS服务端返回的HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 |
| Code | string | 参数解释: OBS服务端返回的错误码。 |
| Message | string | 参数解释: OBS服务端返回的错误描述。 |
| HostId | string | 参数解释: OBS服务端返回的请求服务端ID。 |
| RequestId | string | 参数解释: OBS服务端返回的请求ID。 |
| Id2 | string | 参数解释: OBS服务端返回的请求ID2。 |
| Indicator | string | 参数解释: OBS服务端返回的详细错误码。 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| ETag | String | 参数解释: 段的base64编码的128位MD5摘要。ETag是段内容的唯一标识,可以通过该值识别段内容是否有变化。 取值范围: 长度为32的字符串。 默认取值: 无 |
| Bucket | String | 参数解释: 桶名。 |
| Key | String | 参数解释: 对象名。 |
| UploadId | String | 参数解释: 分段上传任务的ID。 |
| PartNumberMarker | String | 参数解释: 列举已上传段的起始位置,与请求中的该参数对应。 |
| NextPartNumberMarker | String | 参数解释: 下次列举已上传段请求的起始位置。 |
| MaxParts | String | 参数解释: 列举已上传段的返回结果最大段数目,与请求中的该参数对应。 |
| IsTruncated | String | 参数解释: 表明本次请求是否返回了全部结果,“true”表示没有返回全部结果;“false”表示已返回了全部结果。 |
| Parts | Array | 参数解释: 已上传段列表。参见表4 |
| Initiator | Object | 参数解释: 分段上传任务的创建者。参见表5 |
| Owner | Object | 参数解释: 和Initiator相同,代表分段上传任务的创建者。参见表6 |
| StorageClass | String | 参数解释: 待分段上传对象的存储类型。 |
示例代码:简单列举
单次列举分段上传任务。
// 创建ObsClient实例
var obsClient = new ObsClient({
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 前端本身没有process对象,可以使用webpack类打包工具定义环境变量,就可以在代码中运行了。
// 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
access_key_id: process.env.AccessKeyID,
secret_access_key: process.env.SecretAccessKey,
// 这里以华北-北京四为例,其他地区请按实际情况填写
server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
obsClient.listMultipartUploads({
Bucket : 'bucketname'
}, function (err, result) {
if(err){
console.log('Error-->' + err);
}else{
console.log('Status-->' + result.CommonMsg.Status);
if(result.CommonMsg.Status < 300 && result.InterfaceResult){
for(var i in result.InterfaceResult.Uploads){
console.log('Uploads[' + i + ']');
console.log('UploadId-->' + result.InterfaceResult.Uploads[i]['UploadId']);
console.log('Key-->' + result.InterfaceResult.Uploads[i]['Key']);
console.log('Initiated-->' + result.InterfaceResult.Uploads[i]['Initiated']);
}
}
}
}); 示例代码:列举全部分段上传任务
列举所有分段上传任务请参考如下示例:
// 创建ObsClient实例
var obsClient = new ObsClient({
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 前端本身没有process对象,可以使用webpack类打包工具定义环境变量,就可以在代码中运行了。
// 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
access_key_id: process.env.AccessKeyID,
secret_access_key: process.env.SecretAccessKey,
// 这里以华北-北京四为例,其他地区请按实际情况填写
server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
var listAll = function (keyMarker, uploadIdMarker) {
obsClient.listMultipartUploads({
Bucket : 'bucketname',
KeyMarker : keyMarker,
UploadIdMarker : uploadIdMarker
}, function (err, result) {
if(err){
console.log('Error-->' + err);
}else{
console.log('Status-->' + result.CommonMsg.Status);
if(result.CommonMsg.Status < 300 && result.InterfaceResult){
for(var i in result.InterfaceResult.Uploads){
console.log('Uploads[' + i + ']');
console.log('UploadId-->' + result.InterfaceResult.Uploads[i]['UploadId']);
console.log('Key-->' + result.InterfaceResult.Uploads[i]['Key']);
console.log('Initiated-->' + result.InterfaceResult.Uploads[i]['Initiated']);
}
if(result.InterfaceResult.IsTruncated === 'true'){
listAll(result.InterfaceResult.NextKeyMarker, result.InterfaceResult.NextUploadIdMarker);
}
}
}
});
}
listAll();