判断对象是否存在(Python SDK)
功能说明
判断对象是否存在,返回的结果中HTTP状态码为200表明对象存在,否则返回404表明对象或桶不存在。
接口约束
- 您必须是桶拥有者或拥有列举桶内对象的权限,才能判断判断对象是否存在。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:ListBucket权限,如果使用桶策略则需授予ListBucket权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.headObject(bucketName, objectKey, versionId, extensionHeaders)
请求参数
参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
bucketName | str | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
objectKey | str | 必选 | 对象名。 参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
versionId | str | 可选 | 参数解释: 对象的版本号。例如:G001117FCE89978B0000401205D5DC9。 取值范围: 长度为32的字符串。 默认取值: 无,如果不设置则默认指定最新版本的对象。 |
extensionHeaders | dict | 可选 | 参数解释: 接口的拓展头域。 取值范围: 参考自定义头域。 默认取值: 无 |
返回结果
类型 | 说明 |
|---|---|
参数解释: SDK公共结果对象。 |
参数名称 | 参数类型 | 描述 |
|---|---|---|
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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值: 无 |
代码样例
1 2 3 4 5 6 7 8 9 10 11 12 13 | try: resp = obsClient.headObject("bucketname","objectkey") if resp.status < 300: print("Object exists") elif resp.status == 404: errorCode = dict(resp.header).get("error-code") if errorCode is not None and errorCode == "NoSuchKey": print("Object does not exist") print("errorCode:", errorCode) except: import traceback print(traceback.format_exc()) |

如果返回的HTTP状态码为404,可以进一步通过响应头来判断是指定的桶不存在或是对象不存在。

