更新时间:2026-07-13 GMT+08:00
分享

获取桶级默认WORM策略(Java SDK)

功能介绍

获取该桶设置的桶级默认WORM策略。

如果您打开了桶级WORM开关,但从未配置过桶级默认WORM策略,您依然可以使用此接口查看开关的打开情况。

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

接口约束

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

方法定义

obsClient.getObjectLockConfiguration(GetObjectLockConfigurationRequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

表2 GetObjectLockConfigurationRequest

必选

参数解释

请求参数,详见表2 GetObjectLockConfigurationRequest

表2 GetObjectLockConfigurationRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释

桶名。

约束限制:

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

默认取值:

返回结果说明

表3 GetBucketTrashResult

参数名称

参数类型

描述

statusCode

int

参数解释:

HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。

完整的状态码列表请参见状态码

默认取值:

responseHeaders

Map<String, Object>

参数解释:

HTTP响应消息头列表,由多个元组构成。元组中String代表响应消息头的名称,Object代表响应消息头的值。

默认取值:

objectLockConfiguration

表4 ObjectLockConfiguration

参数解释:

WORM策略配置,详见表4 ObjectLockConfiguration

表4 ObjectLockConfiguration

参数名称

参数类型

描述

objectLockEnabled

String

参数解释:

桶级WORM开关状态。

取值范围:

Enabled:启用桶级WORM功能。

rule

表5

参数解释:

桶级WORM策略的规则,详见表5

表5 ObjectLockRule

参数名称

参数类型

描述

defaultRetention

表6

参数解释:

桶级默认WORM策略,详见表6

表6 DefaultRetention

参数名称

参数类型

描述

mode

String

参数解释:

桶的WORM保护策略。

days

int

参数解释:

保护天数。单位:天。

years

int

参数解释:

默认的保护年数,单位:年。

代码示例

本示例用于获取exampleBucket桶的默认WORM保护策略。
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.objectlock.DefaultRetention;
import com.obs.services.model.objectlock.GetObjectLockConfigurationRequest;
import com.obs.services.model.objectlock.GetObjectLockConfigurationResult;
import com.obs.services.model.objectlock.ObjectLockConfiguration;
public class GetObjectLockConfiguration {
    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, 此处以华北-北京四为例,其他地区请按实际情况填写。
        // 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。
        String endPoint = System.getenv("ENDPOINT");
        ObsConfiguration obsConfiguration = new ObsConfiguration();
        obsConfiguration.setEndPoint(endPoint);
        ObsClient obsClient = new ObsClient(ak, sk, securityToken, obsConfiguration);
        try {
            String exampleBucket = "exampleBucket";
            GetObjectLockConfigurationRequest request = new GetObjectLockConfigurationRequest(exampleBucket);
            GetObjectLockConfigurationResult result = obsClient.getObjectLockConfiguration(request);
            ObjectLockConfiguration config = result.getObjectLockConfiguration();
            System.out.println("GetObjectLockConfiguration successfully");
            System.out.println("ObjectLockEnabled: " + config.getObjectLockEnabled());
            if (config.getRule() != null) {
                DefaultRetention retention = config.getRule().getDefaultRetention();
                System.out.println("Mode: " + retention.getMode());
                System.out.println("Days: " + retention.getDays());
                System.out.println("Years: " + retention.getYears());
            }
        } catch (ObsException e) {
            System.out.println("GetObjectLockConfiguration 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("GetObjectLockConfiguration failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

相关链接

  • 更多示例代码,请参见Github示例
  • 配置并行文件系统的回收站过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码

相关文档