tencent cloud

Overview

This document provides an overview of APIs and SDK code samples related to object deletion.

Deleting an object

Description

This API (DELETE Object) is used to delete an object from a COS bucket. To call this API, you must have write access to the bucket.

Sample code

cos.deleteObject({
   Bucket: 'examplebucket-1250000000', /* Your bucket name. Required. */
   Region: 'COS_REGION',  /* Bucket region, such as `ap-beijing`. Required. */
   Key: '1.jpg',  /* Object key stored in the bucket (such as `1.jpg` and `a/b/test.txt`). Required. */
}, function(err, data) {
   console.log(err || data);
});

Parameter description

Callback function description

function(err, data) { ... }

Deleting multiple objects

Description

This API (DELETE Multiple Objects) is used to delete multiple objects from a bucket. You can delete up to 1,000 objects in a single request. There are two response modes for you to choose from: Verbose and Quiet. The Verbose mode returns the deletion result of each object, whereas the Quiet mode returns only information about the objects that fail to be deleted.

Sample code

Deleting multiple files

cos.deleteMultipleObject({
   Bucket: 'examplebucket-1250000000', /* Your bucket name. Required. */
   Region: 'COS_REGION',  /* Bucket region, such as `ap-beijing`. Required. */
   Objects: [
       { Key: '1.jpg' }, /* Object key stored in the bucket (such as `1.jpg` and `a/b/test.txt`). Required. */
       { Key: '2.txt' }, /* Object key stored in the bucket (such as `1.jpg` and `a/b/test.txt`). Required. */
   ]
}, function(err, data) {
   console.log(err || data);
});

Deleting multiple objects with a specified prefix (deleting files in the specified a directory)

var deleteFiles = function (marker) {
  cos.getBucket({
      Bucket: 'examplebucket-1250000000', /* Your bucket name. Required. */
      Region: 'COS_REGION',  /* Bucket region, such as `ap-beijing`. Required. */
      Prefix: 'a/',
      Marker:       marker,
      MaxKeys: 1000,
  }, function (listError, listResult) {
      if (listError) return console.log('list error:', listError);
      var nextMarker = listResult.NextMarker;
      var objects = listResult.Contents.map(function (item) {
          return {Key: item.Key}
      });
      cos.deleteMultipleObject({
          Bucket: bucket,
          Region: region,
          Objects: objects,
      }, function (delError, deleteResult) {
          if (delError) {
              console.log('delete error', delError);
              console.log('delete stop');
          } else {
              console.log('delete result', deleteResult);
              if (listResult.IsTruncated === 'true') deleteFiles(nextMarker);
              else console.log('delete complete');
          }
      });
  });
}
deleteFiles();

Parameter description

Callback function description

function(err, data) { ... }