Help Center> Object Storage Service> SDK Reference> Node.js> Object Download> Downloading an Archive Object
View PDF

Downloading an Archive Object

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

If you want to download an Archive object, you need to restore the object first. Two restore options are supported, as described in the following table.

Option

Description

Value in OBS Node.js SDK

Expedited

Data can be restored within 1 to 5 minutes.

ObsClient.enums.RestoreTierExpedited

Standard

Data can be restored within 3 to 5 hours. This is the default option.

ObsClient.enums.RestoreTierStandard

You can call ObsClient.restoreObject to restore an Archive object. 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'
});

// Restore an Archive object.
obsClient.restoreObject({
       Bucket : 'bucketname',
       Key : 'objectname',
       Days : 1,
       Tier : obsClient.enums.RestoreTierExpedited
}, (err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
              
              // Wait until the object is restored.
              setTimeout(()=>{
                     
                     // Download the object to obtain the object content.
                     obsClient.getObject({
                           Bucket : 'bucketname',
                           Key : 'objectname'
                     }, (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());   
                               }    
                            }
                     });
              }, 6 * 60 * 1000);
       }
});
  • The object specified in ObsClient.restoreObject must be in the OBS Archive storage class. Otherwise, an error will be reported when you call this API.
  • Use the Days parameter to specify the retention period (from 1 to 30 days) of an object and the Tier parameter to specify the time spent on restoring the object.
Parent topic: Object Download