• Object Storage Service

obs
  1. Help Center
  2. Object Storage Service
  3. Developer Guide (Node.js SDK)
  4. Object Download
  5. Downloading a Cold Object

Downloading a Cold Object

If you want to download a Cold object, you need to restore the object first. Three 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

Bulk

Data can be restored within 5 to 12 hours.

ObsClient.enums.RestoreTierBulk

You can call ObsClient.restoreObject to restore a Cold object. Sample code is as follows:

// Import the OBS library.
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 : 'yourdomainname'
});

// Restore an object in the OBS Cold storage class.
obsClient.restoreObject({
       Bucket : 'bucketname',
       Key : 'objectkey',
       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 : 'objectkey'
                     }, (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);
       }
});
NOTE:
  • The object specified in ObsClient.restoreObject must be in the OBS Cold 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.