文档首页/ 对象存储服务 OBS/ SDK参考/ Android/ 桶相关接口/ 归档直读/ 获取桶归档存储对象直读策略
更新时间:2026-09-10 GMT+08:00
分享

获取桶归档存储对象直读策略

功能介绍

桶的所有者可以获取指定桶的归档存储冷存储对象直读状态。

如果从未设置桶的归档存储冷存储对象直读状态,或者已经删除桶的归档存储冷存储对象直读状态,则此操作不会返回桶的归档存储冷存储对象直读状态。

当桶设置了归档存储冷存储对象直读状态,可以通过本接口获取指定桶的归档存储冷存储对象直读状态信息。了解更多归档存储冷存储数据直读相关信息,请参见归档数据直读

接口约束

  • 您必须是桶拥有者或者拥有获取桶归档存储冷存储对象直读策略的权限,才能调用本接口。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetInventoryConfiguration权限,如果使用桶策略则需授予GetInventoryConfiguration权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略自定义创建桶策略
  • OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点
  • 融合桶不支持归档存储冷存储对象直读。

方法定义

obsClient.getBucketDirectColdAccess(BaseBucketRequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

BaseBucketRequest

必选

参数解释:

获取桶的归档存储冷存储对象直读策略请求参数,详见BaseBucketRequest

表2 BaseBucketRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释

桶名。

约束限制:

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

默认取值:

返回结果说明

表3 BucketDirectColdAccess

参数名称

参数类型

描述

status

RuleStatusEnum

参数解释:

标识桶的归档存储冷存储对象直读状态。如果从未设置桶的归档存储冷存储对象直读状态,或者已经删除桶的归档存储冷存储对象直读状态,则不会返回桶的归档存储冷存储对象直读状态。

取值范围:

详见表4 RuleStatusEnum

表4 RuleStatusEnum

常量名

原始值

说明

ENABLED

Enabled

开启桶归档存储冷存储对象直读策略。

DISABLED

Disabled

不开启桶归档存储冷存储对象直读策略。

代码示例

本示例用于获取桶归档存储对象直读策略。

import android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketDirectColdAccess;
import com.obs.services.model.BaseBucketRequest;
import com.obs.services.model.DirectColdAccessEnum;

// 注意:网络操作必须在子线程中执行,否则会抛出NetworkOnMainThreadException
new Thread(() -> {
    // 安全提示:硬编码AK/SK存在安全风险,建议从安全凭证管理系统获取
    String ak = System.getenv("ACCESS_KEY_ID");
    String sk = System.getenv("SECRET_ACCESS_KEY");
    String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";

    ObsClient obsClient = null;
    try {
        obsClient = new ObsClient(ak, sk, endPoint);

        String bucketName = "examplebucket";

        // 获取桶归档直读策略
        BucketDirectColdAccess result = obsClient.getBucketDirectColdAccess(bucketName);
        Log.i("ObsDemo", "获取桶归档直读策略成功,直读策略: " + result.getDirectColdAccess());
    } catch (ObsException e) {
        Log.e("ObsDemo", "获取桶归档直读策略失败,HTTP状态码: " + e.getResponseCode()
                + ",错误码: " + e.getErrorCode()
                + ",错误信息: " + e.getErrorMessage());
    } finally {
        if (obsClient != null) {
            try {
                obsClient.close();
            } catch (Exception e) {
                Log.e("ObsDemo", "关闭ObsClient失败", e);
            }
        }
    }
}).start();

相关文档