# 批量删除对象(Python SDK) #### 功能说明 为节省空间和成本，您可以根据需要删除指定桶中的多个对象。 OBS本身没有文件夹概念，桶中存储的元素只有对象。工具和控制台看到的目录实际上是一个大小为0且对象名以"/"结尾的对象。删除文件夹需列举目录前缀下的所有对象再调用批量删除接口。 批量删除对象特性用于将一个桶内的部分对象一次性删除，删除后不可恢复。批量删除对象要求返回结果里包含每个对象的删除结果。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://developer.huaweicloud.com/endpoint?OBS)。 - 桶没有开启多版本控制功能时，已删除的对象不可恢复，请谨慎操作。 - 批量删除对象一次能接收最大对象数目为1000个，如果超出限制，服务端会返回请求不合法。 - 并发任务分配后，在循环删除多个对象过程中， 如果发生内部错误， 有可能出现数据不一致的情况（某个对象索引数据删除但还有元数据）。 #### 方法定义 ``` ObsClient.deleteObjects(bucketName, deleteObjectsRequest, extensionHeaders) ``` #### 请求参数 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | str | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | deleteObjectsRequest | [DeleteObjectsRequest] | 必选 | **参数解释** **：** 批量删除对象请求参数。详见[DeleteObjectsRequest]。 **默认取值：** 无 | | extensionHeaders | dict | 可选 | **参数解释：** 接口的拓展头域。 **取值范围：** 参考[自定义头域](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1305.html)。 **默认取值：** 无 | 表2DeleteObjectsRequest | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | quiet | bool | 可选 | **参数解释：** 批量删除对象的响应方式。 **取值范围：** - False：表示详细模式，返回删除成功和删除失败的所有结果； - True：表示简单模式，只返回删除过程中出错的结果。 **默认取值：** False | | objects | list of [Object] | 必选 | **参数解释：** 待删除的对象列表，详情参考[Object]。 **默认取值：** 无 | | encoding_type | str | 可选 | **参数解释：** 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 **取值范围：** 可选值为url。 **默认取值：** 无，不设置则不编码。 | 表3Object | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | key | str | 必选 | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | versionId | str | 可选 | **参数解释：** 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 **取值范围：** 长度为32的字符串。 **默认取值：** 无，如果不设置则默认删除最新版本的对象。 | | encoding_type | str | 可选 | **参数解释：** 对响应中的部分元素进行指定类型的编码。如果 delimiter、key_marker、prefix、nextKeyMarker 和 key 包含 xml 1.0 标准不支持的控制字符，可通过设置 encoding_type 对响应中的 delimiter、key_marker、prefix（包括 commonPrefixes 中的 Prefix）、nextKeyMarker 和 key 进行编码。 **取值范围：** 类型：字符串。可选值：url。 | #### 返回结果 表4返回结果 | **类型** | **说明** | |:---|:---| | [GetResult] | **参数解释：** SDK公共结果对象。 | 表5GetResult | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | status | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | reason | str | **参数解释：** HTTP文本描述。 **默认取值：** 无 | | errorCode | str | **参数解释：** OBS服务端错误码，当status参数小于300时为空。 **默认取值：** 无 | | errorMessage | str | **参数解释：** OBS服务端错误描述，当status参数小于300时为空。 **默认取值：** 无 | | requestId | str | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | indicator | str | **参数解释：** OBS服务端返回的错误定位码。 **默认取值：** 无 | | hostId | str | **参数解释：** 请求的服务端ID，当status参数小于300时为空。 **默认取值：** 无 | | resource | str | **参数解释：** 发生错误时相关的桶或对象，当status参数小于300时为空。 **默认取值：** 无 | | header | list | **参数解释：** 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 **默认取值：** 无 | | body | object | **参数解释：** 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见"桶相关接口"章节和"对象相关接口"章节的详细描述。 **默认取值：** 无 | 表6GetResult.body | **GetResult.body类型** | **说明** | |:---|:---| | [DeleteObjectResponse] | **参数解释：** 批量删除对象响应结果。详见[DeleteObjectResponse]。 | 表7DeleteObjectResponse | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | deleteMarker | bool | **参数解释：** 标识删除的对象是否是删除标记。 **取值范围：** - true：是删除标记。 - false：不是删除标记。 **默认取值：** false | | versionId | str | **参数解释：** 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 **取值范围：** 长度为32的字符串。 **默认取值：** 无，如果不设置则默认删除最新版本的对象。 | #### 代码样例 本示例用于批量删除examplebucket桶里的objectkey1和objectkey2对象。 ``` from obs import ObsClient import os import traceback # 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: # 指定待批量删除的对象 object1 = Object(key='objectkey1', versionId=None) object2 = Object(key='objectkey2', versionId=None) # encoding_type参数可以在对象名有特殊字符时使用 encoding_type = 'url' bucketName = "examplebucket" # 批量删除对象 resp = obsClient.deleteObjects(bucketName, DeleteObjectsRequest(quiet=False, objects=[object1, object2], encoding_type=encoding_type)) # 返回码为2xx时，接口调用成功，否则接口调用失败 if resp.status < 300: print('Delete Objects Succeeded') print('requestId:', resp.requestId) if resp.body.deleted: index = 1 for delete in resp.body.deleted: print('delete[' + str(index) + ']') print('key:', delete.key, ',deleteMarker:', delete.deleteMarker, ',deleteMarkerVersionId:', delete.deleteMarkerVersionId) print('versionId:', delete.versionId) index += 1 if resp.body.error: index = 1 for err in resp.body.error: print('err[' + str(index) + ']') print('key:', err.key, ',code:', err.code, ',message:', err.message) print('versionId:', err.versionId) index += 1 else: print('Delete Objects Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except Exception: print('Delete Objects Failed') print(traceback.format_exc()) ``` 本示例用于批量删除examplebucket桶中以test/为前缀的所有对象。 ![](https://support.huaweicloud.com/sdk-python-devg-obs/public_sys-resources/warning_3.0-zh-cn.png) 如果以下示例代码中前缀prefix的值为空字符串或者NULL，将会删除整个桶内的所有文件，请谨慎使用。 ``` from obs import ObsClient import os import traceback # 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: bucketName = "examplebucket" # 指定删除的文件夹 prefix = 'test/' # 指定单次列举对象个数为1000 max_num = 1000 mark = None index = 1 failed_list = [] while True: resp = obsClient.listObjects(bucketName=bucketName, prefix=prefix, marker=mark, max_keys=max_num, encoding_type='url') if resp.status < 300: need_to_delete_objects = [Object(key=i["key"], versionId=None) for i in resp.body["contents"]] del_resp = obsClient.deleteObjects(bucketName, DeleteObjectsRequest(False, need_to_delete_objects, encoding_type="url")) for delete in del_resp.body.deleted: print("Successfully deleted %s " % delete.key) index += 1 if del_resp.body.error: for err in del_resp.body.error: print("Failed to delete %s" % err.key) failed_list.append(err.key) if resp.body.is_truncated is True: mark = resp.body.next_marker else: break else: print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) break print("Total deleted %s objects" % index) for i in failed_list: print("Failed to delete %s, please try again" % i) except Exception: print('Delete Objects Failed') print(traceback.format_exc()) ``` #### 相关链接 - 关于批量删除对象的API说明，请参见[批量删除对象](https://support.huaweicloud.com/api-obs/obs_04_0086.html)。 - 更多关于批量删除对象的示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-python-obs/blob/master/examples/object_operations_sample.py)。 - 批量删除对象过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。