Updated on 2026-01-16 GMT+08:00

Performing a File-Based Download

This example downloads object objectname from bucket bucketname as file.

The example code is as follows:

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    // Hard-coded or plaintext AK/SK are risky. For security purposes, encrypt your AK/SK and store them in the configuration file or environment variables. In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, configure environment variables AccessKeyID and SecretAccessKey.
    // The front-end code does not have the process environment variable, so you need to use a module bundler like webpack to define the process variable.
    // Obtain an AK/SK pair on the management console.
    access_key_id: process.env.AccessKeyID,
    secret_access_key: process.env.SecretAccessKey,
    server: 'https://your-endpoint'
});

obsClient.getObject({
       Bucket : 'bucketname',
       Key : 'objectname',
       SaveByType : 'file'
}, function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
              if(result.CommonMsg.Status < 300 && result.InterfaceResult){
                   // Obtain the download path of the file.
                   console.log('Download Path:'); 
                   console.log(result.InterfaceResult.Content.SignedUrl); 
              }
       }
});
  • Set the SaveByType parameter to file to generate the path for saving the to-be-downloaded file.