Initiate Multipart Upload
API Description
You can use this API to initialize a multipart upload in a specified bucket.
Method Definition
ObsClient.initiateMultipartUpload
Request Parameter
Field |
Type |
Optional or Mandatory |
Description |
---|---|---|---|
Bucket |
String |
Mandatory |
Bucket name |
Key |
String |
Mandatory |
Object name |
ACL |
String |
Optional |
|
StorageClass |
String |
Optional |
Storage class of the object |
Metadata |
Object |
Optional |
Customized metadata of the object |
WebsiteRedirectLocation |
String |
Optional |
Location where the object is redirected to, when the bucket is configured with website hosting |
Expires |
Number |
Optional |
Expiration time of the object, in days |
ContentType |
String |
Optional |
MIME type of the object |
SseKms |
String |
Optional |
Algorithm used in SSE-KMS encryption. The value can be:
|
SseKmsKey |
String |
Optional |
Master key used in SSE-KMS encryption. This field can be null. |
SseC |
String |
Optional |
Algorithm used in SSE-C encryption. The value can be:
|
SseCKey |
Buffer |
Optional |
Key used to encrypt the object in SSE-C mode, which is calculated by using AES256 |
Returned Result (InterfaceResult)
Field |
Type |
Description |
---|---|---|
RequestId |
String |
Request ID returned by the OBS server |
Bucket |
String |
Name of the bucket involved in the multipart upload |
Key |
String |
Name of the object to be uploaded |
UploadId |
String |
Multipart upload ID |
SseKms |
String |
Algorithm used in SSE-KMS encryption |
SseKmsKey |
String |
Key used in SSE-KMS encryption |
SseC |
String |
Algorithm used in SSE-C encryption |
SseCKeyMd5 |
String |
MD5 value of the key used in SSE-C encryption |
Sample Code
obsClient.initiateMultipartUpload({ Bucket:'bucketname', Key : 'objectkey', ContentType : 'text/plain' },(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('UploadId-->' + result.InterfaceResult.UploadId); }else{ console.log('Code-->' + result.CommonMsg.Code); console.log('Message-->' + result.CommonMsg.Message); } } });
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.