Help Center> Object Storage Service> SDK Reference> Node.js> Object Download> Performing a Partial Download
View PDF

Performing a Partial Download

If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference

When only partial data of an object is required, you can download data falling within a specific range. If the specified range is 0 to 1000, data at the zeroth to the thousandth bytes, 1001 bytes in total, will be returned. If the specified range is invalid, data of the whole object will be returned. Sample code is as follows:

// Import the OBS library.
// Use npm to install the client.
var ObsClient = require('esdk-obs-nodejs');
// Use source codes to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    access_key_id: '*** Provide your Access Key ***',       
    secret_access_key: '*** Provide your Secret Key ***',       
    server : 'https://your-endpoint'
});

obsClient.getObject({
       Bucket : 'bucketname',
       Key : 'objectname',
       // Set the start position and end position for downloading.
       Range : 'bytes=0-1000'
}, (err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
              if(result.CommonMsg.Status < 300 && result.InterfaceResult){
                   // Obtain the object content.
                   console.log('Object Content:'); 
                   console.log(result.InterfaceResult.Content.toString()); 
              }
       }
});
  • Use the Range parameter to specify the download range in the "bytes=x-y" format.
  • If the specified range is invalid (because the start or end position is set to a negative integer or the range is larger than the object length), data of the whole object will be returned.
  • This download method also can be used to concurrently download parts of a large object. For details about the sample code, see concurrent-download-object-sample.
Parent topic: Object Download