本文导读

展开导读

文档首页/ 对象存储服务 OBS/ SDK参考/ Java/ 管理桶(Java SDK)/ 设置桶的BPA配置(Java SDK)

设置桶的BPA配置(Java SDK)

更新时间：2025-04-09 GMT+08:00

查看PDF

功能说明

创建或修改OBS桶的PublicAccessBlock配置，以开启或关闭阻止公开访问。

须知：

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

接口约束

您必须是桶拥有者或拥有设置桶BPA配置的权限，才能设置桶桶BPA配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketPublicAccessBlock权限，如果使用桶策略则需授予PutBucketPublicAccessBlock权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
如果开启阻止公开访问，则已有的公开访问权限会被忽略，并且不允许配置新的公开访问权限。如果关闭阻止公开访问，则已有的公开访问权限仍然生效，并且支持配置新的公开访问权限。
Posix桶新桶默认不开启BPA配置，对象桶新桶默认开启BPA配置。

方法定义

obsClient.putBucketPublicAccessBlock(PutBucketPublicAccessBlockRequest request)

设置桶的BPA配置请求参数说明

表1 请求参数列表
参数名称	参数类型	是否必选	描述
request	PutBucketPublicAccessBlockRequest	是	参数解释：设置OBS桶的PublicAccessBlock配置的请求参数，详见PutBucketPublicAccessBlockRequest。

表2 PutBucketPublicAccessBlockRequest
参数名称	参数类型	是否必选	描述
bucketName	String	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
bucketPublicAccessBlock	BucketPublicAccessBlock	可选	参数解释：桶的PublicAccessBlock配置约束限制：无取值范围：无默认取值：无

表3 BucketPublicAccessBlock
参数名称	参数类型	是否必选	描述
blockPublicAcls	Boolean	可选	参数解释：是否锁定公共ACL，当该参数为True时，上传对象，设置Public ACL时禁止对象上传，ACL修改API（修改桶ACL、对象ACL），设置Public ACL时禁止ACL修改。约束限制：无取值范围： True：锁定公共ACL。 Fasle：不锁定公共ACL。默认取值：无
ignorePublicAcls	Boolean	可选	参数解释：是否忽略公共ACL。当该参数为True时，OBS所有OpenAPI进行权限检查时，Public ACL不生效。约束限制：无取值范围： True：忽略公共ACL。 False：不忽略公共ACL。默认取值：无
blockPublicPolicy	Boolean	可选	参数解释：是否锁定公共策略。当该参数为True时，桶策略修改API，设置Public Policy时禁止Policy修改。约束限制：无取值范围： True：锁定公共策略。 False：不锁定公共策略默认取值：无
restrictPublicBuckets	Boolean	可选	参数解释：是否限制账号访问。当该参数为True时，OBS所有OpenAPI进行权限检查时，如果桶策略状态为公开，则只允许云服务账号和本账号访问约束限制：无取值范围： True：限制账号访问。 False：不限制账号访问默认取值：无

返回结果说明

表4 返回结果HeaderResponse(SDK公共响应结果)各项属性说明
参数名称	参数类型	描述
statusCode	int	参数解释： HTTP状态码。取值范围：状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。默认取值：无
responseHeaders	Map<String, Object>	参数解释： HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。默认取值：无

代码示例

为example-posix-bucket-name桶设置桶的BPA配置。

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.bpa.BucketPublicAccessBlock;
import com.obs.services.model.bpa.PutBucketPublicAccessBlockRequest;

import java.util.Map;

public class PutBucketPublicAccessBlockDemo {
    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 bucketName = "example-bucket-name";
            BucketPublicAccessBlock bucketPublicAccessBlock = new BucketPublicAccessBlock();
            bucketPublicAccessBlock.setBlockPublicPolicy(false);
            PutBucketPublicAccessBlockRequest putBucketPublicAccessBlockRequest =
                new PutBucketPublicAccessBlockRequest(bucketName,bucketPublicAccessBlock);
            obsClient.putBucketPublicAccessBlock(putBucketPublicAccessBlockRequest);
            System.out.println("PutBucketPublicAccessBlock successfully");
        } catch (ObsException e) {
            System.out.println("PutBucketPublicAccessBlock 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());
            Map<String, String> headers = e.getResponseHeaders();// 遍历Map的entry,打印所有报错相关头域
            if(headers != null){
                for (Map.Entry<String, String> header : headers.entrySet()) {
                    System.out.println(header.getKey()+":"+header.getValue());
                }
            }
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("PutBucketPublicAccessBlock failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

设置桶的BPA配置(Java SDK)

功能说明

接口约束

方法定义

设置桶的BPA配置请求参数说明

返回结果说明

代码示例

相关链接

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈