Help Center/OBS BrowserJS SDK/API Reference/Object-Related APIs/Complete Multipart Upload
Updated on 2025-12-04 GMT+08:00
View PDF

Complete Multipart Upload

API Description

You can use this API to combine the uploaded parts in a specified bucket by using the multipart upload ID.

Method Definition

ObsClient.completeMultipartUpload

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

Key

String

Mandatory

Object name

RequestDate

String

or

Date

Optional

Request time

NOTE:

When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards.

UploadId

String

Mandatory

Multipart upload ID

Parts

Array

Mandatory

List of parts to be combined

-

PartNumber

String

Mandatory

Part number

ETag

String

Mandatory

Part ETag

Returned Result (InterfaceResult)

Field

Type

Description

RequestId

String

Request ID returned by the OBS server

ETag

String

ETag calculated based on the ETags of all combined parts

Bucket

String

Bucket in which parts are combined

Key

String

Object name obtained after part combination

Location

String

URL of the object generated after part combination

VersionId

String

Version ID of the object obtained after part combination

Sample Code

obsClient.completeMultipartUpload({
       Bucket:'bucketname',
       Key : 'objectkey',
       UploadId : 'uploadid',
       Parts : [{PartNumber : 1, ETag : 'etag1'}, {PartNumber : 2, ETag : 'etag2'}]
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     console.log('Bucket-->' + result.InterfaceResult.Bucket);
                     console.log('Key-->' + result.InterfaceResult.Key);
                     console.log('Location-->' + result.InterfaceResult.Location);
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});
Parent topic:Object-Related APIs