# 批量删除对象(Node.js SDK) ![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/notice_3.0-zh-cn.png) 开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-nodejs-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。 ![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/note_3.0-zh-cn.png) 请您谨慎使用批量删除操作，如果对象所在的桶未开启多版本控制功能，该对象一旦删除将无法恢复。 #### 功能说明 为节省空间和成本，您可以根据需要删除指定桶中的多个对象。 批量删除对象特性用于将一个桶内的部分对象一次性删除，删除后不可恢复。批量删除对象要求返回结果里包含每个对象的删除结果。OBS的批量删除对象使用同步删除对象的方式，每个对象的删除结果返回给请求用户。 #### 接口约束 - 您必须是桶拥有者或拥有批量删除对象的权限，才能批量删除对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:DeleteObject权限，如果使用桶策略则需授予DeleteObject权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[配置对象策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0075.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。 - 桶没有开启多版本控制功能时，已删除的对象不可恢复，请谨慎操作。 - 批量删除对象一次能接收最大对象数目为1000个，如果超出限制，服务端会返回请求不合法。 - 并发任务分配后，在循环删除多个对象过程中， 如果发生内部错误， 有可能出现数据不一致的情况（某个对象索引数据删除但还有元数据）。 #### 方法定义 ``` ObsClient.deleteObjects(params) ``` #### 请求参数 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 长度为3～63个字符。 **默认取值：** 无 | | Quiet | boolean | 可选 | **参数解释：** 批量删除对象的响应方式。 **约束限制：** 无 **取值范围：** - false：表示详细模式，返回删除成功和删除失败的所有结果； - true：表示简单模式，只返回删除过程中出错的结果。 **默认取值：** false | | Objects | [ObjectToDelete]\[\] | 必选 | **参数解释：** 待删除的对象列表，详情参考[ObjectToDelete]。 **约束限制：** 每次最多删除1000个对象。 **取值范围：** 无 **默认取值：** 无 | | EncodingType | string | 可选 | **参数解释：** 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 **约束限制：** 无 **取值范围：** 可选值为url。 **默认取值：** 无，不设置则不编码。 | 表2ObjectToDelete | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Key | string | 必选 | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **约束限制：** 无 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | VersionId | string | 可选 | **参数解释：** 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 **约束限制：** 无 **取值范围：** 长度为32的字符串。 **默认取值：** 无，如果不设置则默认删除最新版本的对象。 | #### 返回结果 表3返回结果 | **参数类型** | 描述 | |:---|:---| | [表4] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表4]。 | 表4Response | **参数名称** | **参数类型** | 描述 | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详[ICommonMsg]。 | | InterfaceResult | [表6] | **参数解释：** 操作成功后的结果数据，详见[表6]。 **约束限制** **：** 当Status大于300时为空。 | 表5ICommonMsg | **参数名称** | **参数类型** | **描述** | |---|---|---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表6DeleteObjectsOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Deleteds | [Deleted]\[\] | **参数解释：** 删除成功的对象列表，详见[Deleted]。 | | Errors | [Error]\[\] | **参数解释：** 删除失败的对象列表，详见[Error]。 | | EncodingType | string | **参数解释：** 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 | 表7Deleted | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Key | string | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 | | VersionId | string | **参数解释：** 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 | | DeleteMarker | bool | **参数解释：** 标识删除的对象是否是删除标记。 **取值范围：** - true：是删除标记。 - false：不是删除标记。 | | DeleteMarkerVersionId | string | **参数解释：** 请求创建或删除的删除标记版本号。 当批量删除请求访问的桶是多版本桶时，如果创建或删除一个删除标记，响应消息会返回该元素。该元素在以下两种情况中会出现： - 用户发送不带版本删除请求，即请求只有对象名，无版本号。这种情况下，系统会创建一个删除标记，并在响应中返回该删除标记的版本号。 - 用户发送带版本删除请求，即请求同时包含对象名以及版本号，但是该版本号标识一个删除标记。这种情况下，系统会删除此删除标记，并在响应中返回该删除标记的版本号。 | 表8Error | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Key | string | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 | | VersionId | string | **参数解释：** 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 | | Code | string | **参数解释**： 删除失败的错误码。可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 | | Message | string | **参数解释**： 删除失败的错误原因。可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 | #### 代码示例 以下代码展示了如何进行批量删除对象： ``` // 引入obs库 // 使用npm安装 const ObsClient = require("esdk-obs-nodejs"); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入 // security_token: process.env.SECURITY_TOKEN, // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function deleteObjects() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", // 指定删除列表 Objects: [ { Key: 'objectname1', VersionId: "version1" }, { Key: 'objectname2', VersionId: "version2" }, { Key: 'objectname3', VersionId: "version3" } ] }; // 批量删除对象 const result = await obsClient.deleteObjects(params); if (result.CommonMsg.Status <= 300) { console.log("Delete objects under the bucket(%s) successful!", params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); // 获取删除成功的对象 console.log('Deleteds:'); for (let i = 0; i < result.InterfaceResult.Deleteds.length; i++) { const deleted = result.InterfaceResult.Deleteds[i]; console.log("Deleted[%d]-Key:%s, VersionId:%s", i, deleted.Key, deleted.VersionId); }; // 获取删除失败的对象 console.log('Errors:'); for (let i = 0; i < result.InterfaceResult.Errors.length; i++) { const err = result.InterfaceResult.Errors[i]; console.log("Errors[%d]-Key:%s, Code:%s", i, err.Key, err.Code); }; }; console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response."); console.log("Status: %d", result.CommonMsg.Status); console.log("Code: %s", result.CommonMsg.Code); console.log("Message: %s", result.CommonMsg.Message); console.log("RequestId: %s", result.CommonMsg.RequestId); } catch (error) { console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network."); console.log(error); }; }; deleteObjects(); ```