Harmony删除文件_对象存储(OSS)-阿里云帮助中心

本文介绍如何在受版本控制的存储空间（Bucket）中删除单个或多个文件（Object）。

注意事项

关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要删除文件，您必须有oss:DeleteObject权限。具体操作，请参见为RAM用户授权自定义的权限策略。

版本控制下的删除行为

版本控制下的删除行为说明如下：

未指定versionId（临时删除）：
如果在未指定versionId的情况下执行删除操作时，默认不会删除Object的当前版本，而是对当前版本插入删除标记（Delete Marker）。当执行GetObject操作时，OSS会检测到当前版本为删除标记，并返回404 Not Found。此外，响应中会返回header：x-oss-delete-marker = true以及新生成的删除标记的版本号x-oss-version-id。
x-oss-delete-marker的值为true，表示与返回的x-oss-version-id对应的版本为删除标记。
指定versionId（永久删除）：
如果在指定versionId的情况下执行删除操作时，OSS会根据指定的versionId参数永久删除该版本。如果需要删除versionId为null的Object，请将接口调用里对应的versionId字段设定为字符串格式的null，从而删除versionId为“null”的Object。

示例代码

删除单个文件

指定versionId删除Object

不指定versionId删除Object

以下代码用于指定versionId对Object进行彻底删除：

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时身份凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时身份凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时身份凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 根据版本ID删除对象
const deleteObjectByVersionId = async () => {
  try {
    // 调用deleteObject方法，根据指定的版本ID删除对象
    const res = await client.deleteObject({
      bucket, // bucket名称
      key, // 对象名称
      versionId: 'versionId' // 指定要删除的对象版本ID
    });

    // 打印返回结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获并处理请求错误
    if (err instanceof RequestError) {
      console.log('错误码: ', err.code); // 错误代码，例如"NoSuchKey"表示对象不存在
      console.log('错误信息: ', err.message); // 错误描述，提供更详细的错误信息
      console.log('请求ID: ', err.requestId); // 请求的唯一标识，用于排查问题
      console.log('HTTP状态码: ', err.status); // HTTP响应状态码，例如404表示资源未找到
      console.log('错误类别: ', err.ec); // 错误类别，进一步分类错误类型
    } else {
      console.log('未知错误: ', err); // 非RequestError类型的错误，可能是其他异常
    }
  }
};

// 调用函数，执行基于版本ID的对象删除操作
deleteObjectByVersionId();

以下代码用于不指定versionId对Object进行临时删除：

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为RAM用户的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为RAM用户的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 填写Bucket所在的地域。例如，华东1（杭州）的Region为'oss-cn-hangzhou'
  region: 'oss-cn-hangzhou',
});

// 指定要操作的Bucket名称，请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';
// 指定要删除的对象（文件）名称，请替换为您实际要删除的对象名称
const key = 'yourObjectName';

/**
 * 删除指定的对象。
 * 使用deleteObject方法删除指定Bucket中的对象。
 */
const deleteObject = async () => {
  try {
    // 调用deleteObject方法删除指定Bucket中的对象
    const res = await client.deleteObject({
      bucket, // Bucket名称
      key,    // 对象（文件）名称
    });

    // 打印删除结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      // 如果是已知类型的错误，则打印错误代码、错误消息、请求ID、状态码、EC码等信息
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      // 打印其他未知类型的错误
      console.log('unknown error: ', err);
    }
  }
};

// 调用deleteObject函数执行删除对象的操作
deleteObject();

删除多个文件

指定versionId删除多个Object

不指定versionID删除多个Object

以下代码用于指定versionId对多个Object进行彻底删除：

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时身份凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时身份凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时身份凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 根据版本ID批量删除多个对象
const deleteMultipleObjectsByVersionId = async () => {
  try {
    // 调用deleteMultipleObjects方法，根据指定的版本ID批量删除多个对象
    const res = await client.deleteMultipleObjects({
      bucket, // bucket名称
      delete: {
        object: [
          { key: 'yourObjectName1', versionId: 'versionId1' }, // 第一个对象及其版本ID
          { key: 'yourObjectName2', versionId: 'versionId2' }, // 第二个对象及其版本ID
          { key: 'yourObjectName3', versionId: 'versionId3' }  // 第三个对象及其版本ID
        ]
      }
    });

    // 打印返回结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获并处理请求错误
    if (err instanceof RequestError) {
      console.log('错误码: ', err.code); // 错误代码，例如"NoSuchKey"表示对象不存在
      console.log('错误信息: ', err.message); // 错误描述，提供更详细的错误信息
      console.log('请求ID: ', err.requestId); // 请求的唯一标识，用于排查问题
      console.log('HTTP状态码: ', err.status); // HTTP响应状态码，例如404表示资源未找到
      console.log('错误类别: ', err.ec); // 错误类别，进一步分类错误类型
    } else {
      console.log('未知错误: ', err); // 非RequestError类型的错误，可能是其他异常
    }
  }
};

// 调用函数，执行基于版本ID的批量删除操作
deleteMultipleObjectsByVersionId();

以下代码用于不指定versionId对多个Object进行临时删除：

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为RAM用户的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为RAM用户的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 填写Bucket所在的地域。例如，华东1（杭州）的Region为'oss-cn-hangzhou'
  region: 'oss-cn-hangzhou',
});

// 指定要操作的Bucket名称，请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';

/**
 * 批量删除对象。
 * 使用deleteMultipleObjects方法批量删除指定Bucket中的多个对象。
 */
const deleteMultipleObjects = async () => {
  try {
    // 调用deleteMultipleObjects方法批量删除指定Bucket中的多个对象
    const res = await client.deleteMultipleObjects({
      bucket, // Bucket名称
      delete: {
        // 指定要删除的对象列表，每个对象通过其key标识
        object: [
          { key: 'yourObjectName1' }, // 对象1的名称，请替换为您实际要删除的对象名称
          { key: 'yourObjectName2' }, // 对象2的名称，请替换为您实际要删除的对象名称
          { key: 'yourObjectName3' }, // 对象3的名称，请替换为您实际要删除的对象名称
        ],
      },
    });

    // 打印批量删除结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      // 如果是已知类型的错误，则打印错误代码、错误消息、请求ID、状态码、EC码等信息
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      // 打印其他未知类型的错误
      console.log('unknown error: ', err);
    }
  }
};

// 调用deleteMultipleObjects函数执行批量删除对象的操作
deleteMultipleObjects();

注意事项

版本控制下的删除行为

示例代码

删除单个文件

删除多个文件

相关文档