Performing a Resumable Upload

API Description

This API is an encapsulated and enhanced version of multipart upload, and aims to eliminate large file upload failures caused by poor network conditions and program breakdowns.

Method Definition

ObsClient.uploadFile

Request Parameter

Returned Result (InterfaceResult)

Sample Code

This example uploads the example file to the examplebucket bucket in a resumable upload and prints the progress.

// Use npm to install the client.
var ObsClient = require('esdk-obs-nodejs');

// Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
// Obtain an AK/SK pair on the management console by referring to https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
const AK = process.env.AccessKeyID
const SK = process.env.SecretAccessKey
// (Optional) If you use a temporary AK/SK pair and a security token to access OBS, obtain them using environment variables.
const security_token= process.env.SecurityToken
// Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one in your actual situation.
const server = "https://obs.ap-southeast-1.myhuaweicloud.com"

var obsClient = new ObsClient({
    access_key_id: AK,
    secret_access_key: SK,
    server: server,
});

const Bucket = 'examplebucket'
// Name of the object after being uploaded
const Key = 'objectname'
// Local file to be uploaded
const UploadFile = 'D:\\example'
// Part size, in bytes. The value ranges from 100 KB to 5 GB and is 5 MB by default.
const PartSize = 10 * 1024 * 1024
// Maximum number of concurrent part uploads. The default value is 20.
const TaskNum = 10
// Define the control parameter for canceling the resumable upload.
var hook;
// Perform the resumable upload.
try {
    obsClient.uploadFile({
        Bucket,
        Key,
        UploadFile,
        PartSize,
        TaskNum,
        // Enable the resumable upload.
        EnableCheckpoint: true,
        // Progress callback
        ProgressCallback: function (transferredAmount, totalAmount, totalSeconds) {
            // Print the upload speed in KB/s.
            console.log(transferredAmount * 1.0 / totalSeconds / 1024);
            // Print the upload percentage.
            console.log(transferredAmount * 100.0 / totalAmount);
            // Pause the upload when the progress reaches 50%.
            // if(hook && (transferredAmount / totalAmount) > 0.5){
            //     // Pause the resumable upload.
            //     hook.cancel();
            // }
        },
        ResumeCallback: function (resumeHook) {
            // Obtain the control parameter for canceling the resumable upload.
            hook = resumeHook;
        }
    }, (err, result) => {
        if (err) {
            console.log('UploadFile Failed')
            console.error('Error-->' + err);
        } else {
            // If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails.
            if (result.CommonMsg.Status < 300) {
                console.log('UploadFile Succeeded')
                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('UploadFile Failed')
                console.log('ErrorCode-->' + result.CommonMsg.Code);
                console.log('ErrorMessage-->' + result.CommonMsg.Message);
            }
        }
    });
} catch (error) {
    console.log('UploadFile Failed')
    console.error('Error-->' + error);
}