# 设置桶的BPA配置(Java SDK) #### 功能介绍 创建或修改OBS桶的PublicAccessBlock配置，以开启或关闭阻止公开访问。 ![](https://support.huaweicloud.com/sdk-java-devg-obs/public_sys-resources/notice_3.0-zh-cn.png) 开发过程中，您有任何问题可以在Github上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-java-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。 #### 接口约束 - 您必须是桶拥有者或拥有设置桶BPA配置的权限，才能设置桶BPA配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketPublicAccessBlock权限，如果使用桶策略则需授予PutBucketPublicAccessBlock权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的region以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 - 如果开启阻止公开访问，则已有的公开访问权限会被忽略，并且不允许配置新的公开访问权限。如果关闭阻止公开访问，则已有的公开访问权限仍然生效，并且支持配置新的公开访问权限。 - Posix桶新桶默认不开启BPA配置，对象桶新桶默认开启BPA配置。 #### 方法定义 obsClient.putBucketPublicAccessBlock([PutBucketPublicAccessBlockRequest] request) #### 设置桶的BPA配置请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | request | [PutBucketPublicAccessBlockRequest] | 是 | **参数解释** **：** 设置OBS桶的PublicAccessBlock配置的请求参数，详见[PutBucketPublicAccessBlockRequest]。 | 表2PutBucketPublicAccessBlockRequest | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | String | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | bucketPublicAccessBlock | [BucketPublicAccessBlock] | 可选 | **参数解释：** 桶的PublicAccessBlock配置 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表3BucketPublicAccessBlock | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | blockPublicAcls | Boolean | 可选 | **参数解释：** 指定是否应该禁止为桶或桶内对象配置公开的ACL（access control list）。如果指定为true，会出现以下现象： - 上传对象时，如果指定公开的ACL，则上传对象失败，返回403 Access Denied。 - 修改桶ACL或对象ACL时，如果指定公开的ACL，则修改ACL失败，返回403 Access Denied。 **约束限制：** 该配置不会对存量桶或对象造成影响。blockPublicAcls、blockPublicPolicy、ignorePublicAcls、restrictPublicBuckets这四个参数至少需要指定其中一个。 **取值范围：** - True：锁定公共ACL。 - False：不锁定公共ACL。 **默认取值：** 无 | | ignorePublicAcls | Boolean | 可选 | **参数解释：** 是否忽略公共ACL。当该参数为True时，OBS所有OpenAPI进行权限检查时，Public ACL不生效。 **约束限制：** 该配置不会影响已有的ACL，也不会阻止配置新的公开ACL。blockPublicAcls、blockPublicPolicy、ignorePublicAcls、restrictPublicBuckets这四个参数至少需要指定其中一个。 **取值范围：** - True：忽略公共ACL。 - False：不忽略公共ACL。 **默认取值：** 无 | | blockPublicPolicy | Boolean | 可选 | **参数解释：** 指定是否应该禁止为桶配置公开的桶策略。如果指定为true，会出现以下现象：为桶配置桶策略时，如果指定公开的桶策略，则配置桶策略失败，返回403 Access Denied。 **约束限制：** 该配置不会对存量桶造成影响。blockPublicAcls、blockPublicPolicy、ignorePublicAcls、restrictPublicBuckets这四个参数至少需要指定其中一个。 **取值范围：** - True：锁定公共策略。 - False：不锁定公共策略 **默认取值：** 无 | | restrictPublicBuckets | Boolean | 可选 | **参数解释：** 指定是否需要对已有的公开桶策略进行限制。如果指定为true，会出现以下现象：桶策略为公开时，只允许云服务账号和桶拥有者账号对该桶访问。 **约束限制：** 该配置不会影响已有的桶策略，也不会阻止配置新的公开桶策略。blockPublicAcls、blockPublicPolicy、ignorePublicAcls、restrictPublicBuckets这四个参数至少需要指定其中一个。 **取值范围：** - True：限制账号访问。 - False：不限制账号访问 **默认取值：** 无 | #### 返回结果说明 表4返回结果HeaderResponse(SDK公共响应结果)各项属性说明 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | statusCode | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | responseHeaders | Map\ | **参数解释：** HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无 | #### 代码示例 本示例为example-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 headers = e.getResponseHeaders();// 遍历Map的entry,打印所有报错相关头域 if(headers != null){ for (Map.Entry header : headers.entrySet()) { System.out.println(header.getKey()+":"+header.getValue()); } } e.printStackTrace(); } catch (Exception e) { System.out.println("PutBucketPublicAccessBlock failed"); // 其他异常信息打印 e.printStackTrace(); } } } ``` #### 相关链接 - 关于设置桶的BPA配置的API说明，请参见[设置桶级阻止公共访问配置](https://support.huaweicloud.com/api-obs/obs_04_0174.html)。 - 设置桶的BPA配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 桶和对象相关常见问题请参见[桶和对象相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_1200.html)。