九游平台/ 对象存储服务 obs/ sdk参考/ / 上传对象(java sdk)/ / 取消分段上传任务(java sdk)
更新时间:2024-11-06 gmt 08:00

取消分段上传任务(java sdk)-九游平台

功能说明

通过分段上传任务的id,取消指定桶中的分段上传任务。

您可以选择取消多段上传任务,取消多段上传任务之后无法再次使用该上传id上传任何段。然后,obs将释放被取消的多段上传任务中的每个段数据的所有存储。如果有多段上传已在进行中,即使您已执行中止操作,它们仍可以上传成功或失败。如果要释放所有分段使用的所有存储,必须在完成所有多段上传后再取消多段上传任务。

开发过程中,您有任何问题可以在github上,或者在中发帖求助。

接口约束

  • 您必须是桶拥有者或拥有取消分段上传任务的权限,才能取消分段上传任务。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:object:abortmultipartupload权限,如果使用桶策略则需授予abortmultipartupload权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
  • obs支持的region以及region与endpoint的对应关系,详细信息请参见。

方法定义

obsclient.abortmultipartupload(abortmultipartuploadrequest request)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

abortmultipartuploadrequest

必选

参数解释:

取消分段请求参数,详见abortmultipartuploadrequest

表2 abortmultipartuploadrequest

参数名称

参数类型

是否必选

描述

bucketname

string

必选

桶名。

参数解释

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用ip地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

默认取值:

objectkey

string

必选

参数解释:

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。

例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。

取值范围:

长度大于0且不超过1024的字符串。

默认取值:

uploadid

string

必选

参数解释:

分段上传任务的id,例如:000001648453845dbb78f2340dd460d8

取值范围:

长度为32的字符串。

默认取值:

返回结果说明

表3 返回结果headerresponse(sdk公共响应结果)各项属性说明

参数名称

参数类型

描述

statuscode

int

参数解释:

http状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。

完整的状态码列表请参见。

默认取值:

responseheaders

map

参数解释:

http响应消息头列表,由多个元组构成。元组中string代表响应消息头的名称,object代表响应消息头的值。

默认取值:

代码示例

通过obsclient.abortmultipartupload利用初始化多段上传时获取的uploadid,取消对examplebucket桶中的objectname对象分段上传任务。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
importcom.obs.services.obsclient;
importcom.obs.services.exception.obsexception;
importcom.obs.services.model.abortmultipartuploadrequest;
publicclass abortmultipartupload001{
publicstaticvoidmain(string[]args){
// 您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
// 您可以登录访问管理控制台获取访问密钥ak/sk
stringak=system.getenv("access_key_id");
stringsk=system.getenv("secret_access_key_id");
// 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。
// 您可以通过环境变量获取访问密钥ak/sk/securitytoken,也可以使用其他外部引入方式传入。
stringsecuritytoken=system.getenv("security_token");
// endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
stringendpoint="https://obs.cn-north-4.myhuaweicloud.com";
// 您可以通过环境变量获取endpoint,也可以使用其他外部引入方式传入。
//string endpoint = system.getenv("endpoint");
// 创建obsclient实例
// 使用永久ak/sk初始化客户端
obsclientobsclient=newobsclient(ak,sk,endpoint);
// 使用临时ak/sk和securitytoken初始化客户端
// obsclient obsclient = new obsclient(ak, sk, securitytoken, endpoint);
try{
stringuploadid="upload id from initiatemultipartupload";
// 取消分段上传任务请求
abortmultipartuploadrequestrequest=newabortmultipartuploadrequest("examplebucket","objectname",uploadid);
// 取消分段上传任务接口
obsclient.abortmultipartupload(request);
system.out.println("abortmultipartupload successfully");
}catch(obsexceptione){
system.out.println("abortmultipartupload failed");
// 请求失败,打印http状态码
system.out.println("http code:"e.getresponsecode());
// 请求失败,打印服务端错误码
system.out.println("error code:"e.geterrorcode());
// 请求失败,打印详细错误信息
system.out.println("error message:"e.geterrormessage());
// 请求失败,打印请求id
system.out.println("request id:"e.geterrorrequestid());
system.out.println("host id:"e.geterrorhostid());
e.printstacktrace();
}catch(exceptione){
system.out.println("abortmultipartupload failed");
// 其他异常信息打印
e.printstacktrace();
}
}
}

相关链接

  • 关于分段上传-取消分段上传任务的api说明,请参见取消多段上传任务
  • 更多关于分段上传的示例代码,请参见。
  • 分段上传过程中返回的错误码含义、问题原因及处理措施可参考obs错误码

相关文档

网站地图