Object Storage Service:Delete files (Node.js SDK)

How versioning affects deletion

When deleting an object from a versioning-enabled bucket, the behavior depends on whether you specify a version ID.

• Without a version ID (temporary deletion): OSS adds a delete marker as the latest version instead of removing the object. Subsequent GetObject requests return 404 Not Found with the response headers x-oss-delete-marker: true and x-oss-version-id set to the delete marker's version ID.

• With a version ID (permanent deletion): OSS permanently removes the specified version. To delete a version with a null ID, set versionId to the string "null".

Prerequisites

• The ali-oss SDK is installed. For more information, see Get started with OSS SDK for Node.js.

• An OSS client instance is initialized. All examples in this topic use the following client configuration:

    const OSS = require("ali-oss");
  
    const client = new OSS({
      // Specify the region. Example: oss-cn-hangzhou.
      region: "<your-region>",
      // Obtain access credentials from environment variables.
      accessKeyId: process.env.OSS_ACCESS_KEY_ID,
      accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
      authorizationV4: true,
      bucket: "<your-bucket-name>",
    });

Delete a single object

const versionId = "<your-version-id>";
const objectName = "exampleobject.txt";

async function deleteVersionObject() {
  const result = await client.delete(objectName, {
    versionId,
  });
  console.log(result);
}

deleteVersionObject();

const objectName = "exampleobject.txt";

async function deleteObject() {
  const result = await client.delete(objectName);
  console.log(result);
}

deleteObject();

Delete multiple objects

const names = [
  { key: "key1.js", versionId: "versionId1" },
  { key: "key2.js", versionId: "versionId2" },
];

async function deleteMulti() {
  const result = await client.deleteMulti(names);
  console.log(result);
}

deleteMulti();

const names = ["key1.js", "key2.js"];

async function deleteMulti() {
  const result = await client.deleteMulti(names);
  console.log(result);
}

deleteMulti();

Delete objects by name prefix

List all object versions matching a prefix, then delete each version.

const prefix = "test";

async function deleteByPrefix() {
  const list = await client.getBucketVersions({
    prefix: prefix,
  });

  for (let i = 0; i < list.objects.length; i++) {
    const obj = list.objects[i];
    await client.delete(obj.name, {
      versionId: obj.versionId,
    });
  }
}

deleteByPrefix();

References

• DeleteObject

• DeleteMultipleObjects