首页 > 华为云产品及优惠 > 华为云云存储

华为云对象存储OBS删除对象(Python SDK)_云淘科技

11 月 24, 2023
107 0

功能说明

为节省空间和成本，您可以根据需要删除指定桶中的单个对象。

接口约束

您必须是桶拥有者或拥有删除对象的权限，才能删除对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:DeleteObject权限，如果使用桶策略则需授予DeleteObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
桶没有开启多版本控制功能时，已删除的对象不可恢复，请谨慎操作。

方法定义

ObsClient.deleteObject(bucketName, objectKey, versionId)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
桶命名规则如下：

3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
禁止使用IP地址。
禁止以“-”或“.”开头及结尾。
禁止两个“.”相邻（如：“my..bucket”）。
禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。

同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

objectKey

str

必选

参数解释：

目标对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

versionId

str

可选

参数解释：

对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。

取值范围：

长度为32的字符串。

默认取值：

无，若不设置则默认删除最新版本的对象。

返回结果

表2 返回结果

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表3 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无
表4 GetResult.body

GetResult.body类型

说明

DeleteObjectResponse

参数解释：

删除对象响应结果。详见DeleteObjectResponse。
表5 DeleteObjectResponse

参数名称

参数类型

描述

deleteMarker

bool

参数解释：

标识删除的对象是否是删除标记。

取值范围：

true：是删除标记。
false：不是删除标记。

默认取值：

false

versionId

str

参数解释：

对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。

取值范围：

长度为32的字符串。

默认取值：

无，若不设置则默认删除最新版本的对象。

代码样例

本示例用于删除examplebucket桶中的objectname单个对象。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
security_token = os.getenv("SecurityToken")
#  server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    objectKey = "objectname"
    # 如果删除多版本对象请指定versionId,未开启多版本则为null
    versionId = 'null'
    # 删除单个对象
    resp = obsClient.deleteObject(bucketName, objectKey, versionId)
    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Delete Object Succeeded')
        print('requestId:', resp.requestId)
        print('deleteMarker:', resp.body.deleteMarker)
        print('versionId:', resp.body.versionId)
    else:
        print('Delete Object Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Delete Object Failed')
    print(traceback.format_exc())

相关链接

关于删除对象的API说明，请参见删除对象。
更多关于删除对象的示例代码，请参见Github示例。
删除对象过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。

父主题： 对象相关接口

同意关联代理商云淘科技，购买华为云产品更优惠（QQ 78315851）

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家

相关文章

分类

近期文章

近期评论

您尚未收到任何评论。

友情链接

同尘科技 同尘云 云淘科技 数据百度 西数云 站长论坛 阿里云代理 阿里云代理商 阿里云优惠 腾讯云代理 腾讯云优惠 云小二

分类目录