Updated on 2024-02-28 GMT+08:00

Deleting Objects

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.

Exercise caution when performing this operation. If the versioning function is disabled for the bucket where the object is located, the object cannot be restored after being deleted.

Deleting a Single Object

You can call ObsClient.deleteObject to delete a single 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({
       //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. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
       access_key_id: process.env.ACCESS_KEY_ID,
       secret_access_key: process.env.SECRET_ACCESS_KEY,
       server : 'https://your-endpoint'
});

obsClient.deleteObject({
       Bucket: 'bucketname',
       Key : 'objectname'
}, (err, result) => {
       if(err){
              console.log('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
       }
});

Deleting Objects in a Batch

You can call ObsClient.deleteObjects to delete objects in a batch.

A maximum of 1000 objects can be deleted each time. Two response modes are supported: verbose (detailed) and quiet (brief).

  • In verbose mode (default mode), the returned response includes the deletion result of each requested object.
  • In quiet mode, the returned response includes only results of objects failed to be deleted.

Sample code:

// 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({
       //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. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
       access_key_id: process.env.ACCESS_KEY_ID,
       secret_access_key: process.env.SECRET_ACCESS_KEY,
       server : 'https://your-endpoint'
});
 
obsClient.deleteObjects({ 
       Bucket: 'bucketname', 
      // Set the response mode to verbose.
       Quiet : false, 
       Objects : [{Key:'objectname1'},{Key:'objectname2'}, {Key : 'objectname3'}] 
}, (err, result) => { 
       if(err){ 
              console.log('Error-->' + err); 
       }else{ 
              console.log('Status-->' + result.CommonMsg.Status); 
              if(result.CommonMsg.Status < 300 && result.InterfaceResult){
                // Obtain the list of successfully deleted objects.
                console.log('Deleteds:'); 
                for(let i=0;i<result.InterfaceResult.Deleteds.length;i++){ 
                       console.log('Deleted[' + i + ']:'); 
                       console.log('Key-->'+result.InterfaceResult.Deleteds[i]['Key']); 
                       console.log('VersionId-->' + result.InterfaceResult.Deleteds[i]['VersionId']); 
                } 
                // Obtain the list of objects failed to be deleted.
                console.log('Errors:'); 
                for(let i=0;i<result.InterfaceResult.Errors.length;i++){ 
                       console.log('Error[' + i + ']:'); 
                       console.log('Key-->' + result.InterfaceResult.Errors[i]['Key']); 
                       console.log('VersionId-->' + result.InterfaceResult.Errors[i]['VersionId']); 
                } 
              }
       } 
});

Use the Quiet parameter to specify the response mode and the Objects parameter to specify the to-be-deleted objects.