更新时间：2026-08-28 GMT+08:00

取消分段上传任务(HarmonyOS SDK)

功能说明

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

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

接口约束

您必须是桶拥有者或拥有取消分段上传任务的权限，才能取消分段上传任务。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:AbortMultipartUpload权限，如果使用桶策略则需授予AbortMultipartUpload权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

     abortMultipartUpload(input: AbortMultipartUploadInput): Response<BaseResponseOutput>

请求参数

表1 请求参数列表
参数名称	参数类型	是否必选	描述
input	AbortMultipartUploadInput	必选	参数解释：取消分段上传任务接口入参，详见AbortMultipartUploadInput。

表2 AbortMultipartUploadInput
参数名称	参数类型	是否必选	描述
Bucket	string	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
Key	string	必选	参数解释：对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无
UploadId	string	必选	参数解释：分段上传任务的ID。例如：000001648453845DBB78F2340DD460D8。取值范围：长度为32的字符串。默认取值：无

返回结果

表3 返回结果
参数类型	描述
Response 说明：该接口返回一个Promise类型，需要使用Promise、async/await语法处理。	参数解释：接口返回信息，详见Response。

表4 Response
参数名称	参数类型	描述
CommonMsg	ICommonMsg	参数解释：接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。
InterfaceResult	BaseResponseOutput	参数解释：操作成功后的结果数据，详见BaseResponseOutput。约束限制：当Status大于300时为空。

表5 ICommonMsg
参数名称	参数类型	描述
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服务端返回的详细错误码。

表6 BaseResponseOutput
参数名称	参数类型	描述
RequestId	string	参数解释： OBS服务端返回的请求ID。
Id2	string	参数解释： OBS服务端返回的请求ID2。

代码示例

本示例用于取消名为examplebucket桶中的分段上传任务，并且对象名是example/objectname，上传任务的ID是00000188677110424014075CC4A77xxx。

     // 引入依赖包
import ObsClient, { AbortMultipartUploadInput } from '@obs/esdk-obs-harmony';
import { process } from '@kit.ArkTS';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const processManager = new process.ProcessManager();

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"),
  SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"),
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入
  // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"),
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function abortMultipartUpload() {
  try {
    const params: AbortMultipartUploadInput = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定对象，此处以 example/objectname 为例
      Key: "example/objectname",
      // 指定多段上传任务号，此处以 00000188677110424014075CC4A77xxx 为例
      UploadId: "00000188677110424014075CC4A77xxx",
    };
    // 取消分段上传任务
    const result = await obsClient.abortMultipartUpload(params);
    if (result.CommonMsg.Status < 300) {
      hilog.info(0x0001, 'OBS-Harmony', "Abort multipart upload successful!");
      hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId);
      return;
    }
    hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status);
    hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code);
    hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message);
    hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    const err = error as BusinessError;
    hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message);
  }
}

abortMultipartUpload();
 
 
  