PUT Part

Updated on 2022-02-10 GMT+08:00

View PDF

API Description

After a multipart upload is initialized, you can use this API to upload a part to a specified bucket by using the multipart upload ID. Except for the part last uploaded whose size ranges from 0 to 5 GB, sizes of the other parts range from 100 KB to 5 GB. The upload part ID ranges from 1 to 10000.

Method Definition

ObsClient.uploadPart

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.
PartNumber	Number	Mandatory	Part number, which ranges from 1 to 10000
UploadId	String	Mandatory	Multipart upload ID
ContentMD5	String	Optional	Base64-encoded MD5 value of the object data to be uploaded. It is provided for the OBS server to verify data integrity.
Body	String	Optional	Object content to be uploaded
SourceFile	File or Blob	Optional	Source file containing the part (The browser must support FileReader.)
ProgressCallback	Function	Optional	Callback function for obtaining the upload progress NOTE: This callback function contains the following parameters in sequence: Number of uploaded bytes, total bytes, and used time (unit: second).
Offset	Number	Optional	Start offset (in bytes) of a part in the source file. The default value is 0. This field is effective only when SourceFile is set.
PartSize	Number	Optional	Size (in bytes) of a part in the source file. The default value is the file size minus Offset. This field is effective only when SourceFile is set. Except for the part lastly being uploaded whose size ranging from 0 to 5 GB, sizes of the other parts range from 100 KB to 5 GB.
SseC	String	Optional	Algorithm used in SSE-C encryption. The value can be: AES256
SseCKey	String	Optional	Key used in SSE-C encryption. It is calculated by using AES-256.

NOTE:

Body and SourceFile cannot be used together.
If both Body and SourceFile are null, the size of the object to be uploaded is 0 bytes.
Offset, PartSize, and SourceFile are used together to specify a part of the source file to be uploaded.

Returned Result (InterfaceResult)

Field	Type	Description
RequestId	String	Request ID returned by the OBS server
ETag	String	ETag of the uploaded part

Sample Code

obsClient.uploadPart({
       Bucket:'bucketname',
       Key : 'objectkey',
       UploadId : 'uploadid',
       PartNumber : 1,
       Body : 'Hello OBS'
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     console.log('ETag-->' + result.InterfaceResult.ETag);
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});

Parent topic: Object-Related APIs

Previous topic: Initiate Multipart Upload

Next topic: PUT Part - Copy