设置桶的BPA配置(Java SDK)

功能介绍

创建或修改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配置请求参数说明

返回结果说明

代码示例

本示例为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<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();
        }
    }
}

相关链接

• 关于设置桶的BPA配置的API说明，请参见设置桶级阻止公共访问配置。
• 设置桶的BPA配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
• 桶和对象相关常见问题请参见桶和对象相关常见问题。