更新时间:2026-08-14 GMT+08:00

判断对象是否存在

功能介绍

判断对象是否存在,返回的结果中HTTP状态码为200表明对象存在,返回404表明对象或桶不存在。

接口约束

  • 您必须是桶拥有者或拥有获取对象元数据的权限,才能判断对象是否存在。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:GetObject权限,如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略配置对象策略
  • OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点

方法定义

obsClient.doesObjectExist(final GetObjectMetadataRequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

GetObjectMetadataRequest

必选

参数解释

设置对象属性请求参数,详见GetObjectMetadataRequest

表2 GetObjectMetadataRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

默认取值:

objectKey

String

必选

参数解释:

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

例如,您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt,对象名为folder/test.txt。

取值范围:

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

默认取值:

versionId

String

可选

参数解释:

对象的版本号。

取值范围:

长度为32的字符串。

默认取值:

userHeaders

HashMap<String, String>

可选

参数解释:

用户头域列表。HashMap中第一个String代表用户头域名称,第二个String代表用户头域名称对应的取值。通过每个SDK设置的用户头域userHeader透传给服务端,使SDK不做处理,让后续使用更灵活。

取值范围:

长度为32的字符串。

默认取值:

encodeHeaders

boolean

可选

参数解释:

设置对象元数据接口允许指定是否编解码http头域。

取值范围:

true:对象元数据接口允许进行编解码http头域。

false:对象元数据接口允许不进行编解码http头域。

默认取值:

默认为true,默认会进行编解码。

sseHeader

SseCHeader

可选

参数解释:

服务端解密头信息。详见SseCHeader

表3 SseCHeader

参数名称

参数类型

是否必选

描述

algorithm

ServerAlgorithm

必选

参数解释:

表示服务端加密是SSE-C方式,对象使用SSE-C加密方式。

取值范围:

可选值:AES256,即选择SSE-C方式,使用高级加密标准(Advanced Encryption Standard,AES)加密对象。详见ServerAlgorithm

默认取值:

sseAlgorithm

SSEAlgorithmEnum

可选

参数解释:

加密算法。

约束限制:

只支持AES256。

取值范围:

详见SSEAlgorithmEnum

默认取值:

sseCKey

byte[]

必选

参数解释:

SSE-C方式下加密使用的原始密钥,byte[]形式,该密钥用于加密对象。

默认取值:

sseCKeyBase64

String

可选

参数解释:

SSE-C方式下的密钥,由原始密钥经过Base64编码后得到,该密钥用于加密对象。

默认取值:

表4 ServerAlgorithm

常量值

原始值

AES256

AES256

表5 SSEAlgorithmEnum

常量值

原始值

KMS

kms

AES256

AES256

返回结果说明

表6 返回结果如下

方法名称

返回值类型

说明

doesObjectExist(final GetObjectMetadataRequest request)

boolean

用于判断桶中相关对象是否存在。

代码示例

以下代码展示如何判断examplebucket桶中objectname对象是否存在。

import android.util.Log;

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.GetObjectMetadataRequest;

public class DoesObjectExistDemo {
    private static final String TAG = "DoesObjectExistDemo";

    public void doesObjectExist() {
        // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
        String endPoint = "https://your-endpoint";

        // 创建ObsClient实例
        ObsClient obsClient = new ObsClient(ak, sk, endPoint);

        try {
            // 判断指定的对象是否存在
            boolean exists = obsClient.doesObjectExist("examplebucket", "objectname");
            Log.i(TAG, exists ? "object exists!" : "object does not exist!");
            Log.i(TAG, "doesObjectExist successfully");

            // 也可使用GetObjectMetadataRequest方式
            GetObjectMetadataRequest request = new GetObjectMetadataRequest("examplebucket", "objectname");
            boolean exists2 = obsClient.doesObjectExist(request);
            Log.i(TAG, exists2 ? "object exists!" : "object does not exist!");
        } catch (ObsException e) {
            Log.e(TAG, "doesObjectExist failed");
            // 请求失败,打印http状态码
            Log.e(TAG, "HTTP Code:" + e.getResponseCode());
            // 请求失败,打印服务端错误码
            Log.e(TAG, "Error Code:" + e.getErrorCode());
            // 请求失败,打印详细错误信息
            Log.e(TAG, "Error Message:" + e.getErrorMessage());
            // 请求失败,打印请求id
            Log.e(TAG, "Request ID:" + e.getErrorRequestId());
            Log.e(TAG, "Host ID:" + e.getErrorHostId());
        } catch (Exception e) {
            Log.e(TAG, "doesObjectExist failed");
            // 其他异常信息打印
            Log.e(TAG, e.getMessage());
        }
    }
}