更新时间:2026-04-02 GMT+08:00
分享

获取桶归档存储对象直读策略(Java SDK)

功能介绍

用户可通过本章节指导获取桶的归档存储对象直读策略。

开发过程中,您有任何问题可以在github上提交issue,或者在华为云对象存储服务论坛中发帖求助。

接口约束

  • 您必须是桶拥有者或拥有获取桶归档存储对象直读策略的权限,才能获取桶归档存储对象直读策略。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetDirectColdAccessConfiguration权限,如果使用桶策略则需授予GetDirectColdAccessConfiguration权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略自定义创建桶策略
  • OBS支持的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 com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.HeaderResponse;
import com.obs.services.model.Qos.BpsLimitConfiguration;
import com.obs.services.model.Qos.NetworkType;
import com.obs.services.model.Qos.QosConfiguration;
import com.obs.services.model.Qos.QosRule;
import com.obs.services.model.Qos.QpsLimitConfiguration;
import com.obs.services.model.Qos.SetBucketQosRequest;
import java.util.Map;
public class GetBucketDirectColdAccess {
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken,也可以使用其他外部引入方式传入。
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。
        // String endPoint = System.getenv("ENDPOINT");
        
        // 创建ObsClient实例
        // 使用永久AK/SK初始化客户端
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // 使用临时AK/SK和SecurityToken初始化客户端
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
        try {
            String exampleBucket = "exampleBucket";
            BucketDirectColdAccess access = obsClient.getBucketDirectColdAccess(exampleBucket);
            System.out.println("Access status:"+ access.getStatus() );
            System.out.println("GetBucketDirectColdAccess successfully");
        } catch (ObsException e) {
            System.out.println("GetBucketDirectColdAccess failed");
            // 请求失败,打印http状态码
            System.out.println("HTTP Code:" + e.getResponseCode());
            // 请求失败,打印服务端错误码
            System.out.println("Error Code:" + e.getErrorCode());
            // 请求失败,打印详细错误信息
            System.out.println("Error Message:" + e.getErrorMessage());
            // 请求失败,打印请求id
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("GetBucketDirectColdAccess failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

相关文档