Obtaining the BPA Configuration of a Bucket (SDK for Java)

Function

This API returns the public access block configuration of an OBS bucket.

If you have any questions during development, post them on the Issues page of GitHub.

Restrictions

• To obtain the BPA configuration of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketPublicAccessBlock in IAM or GetBucketPublicAccessBlock in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
• The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

obsClient.getBucketPublicAccessBlock(GetBucketPublicAccessBlockRequest request )

Request Parameters

Responses

Code Examples

This example obtains the BPA configuration of bucket example-bucket-name.

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

import java.util.Map;

public class GetBucketPublicAccessBlockDemo {
    public static void main(String[] args) {

        // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // Obtain an endpoint using environment variables or import it in other ways.
        // String endPoint = System.getenv("ENDPOINT");
        
        // Create an ObsClient instance.
        // Use a permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk, endPoint);
        // Use a temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
        try {
            String bucketName = "example-bucket-name";
            GetBucketPublicAccessBlockRequest getBucketPublicAccessBlockRequest =
                new GetBucketPublicAccessBlockRequest();
            getBucketPublicAccessBlockRequest.setBucketName(bucketName);
            GetBucketPublicAccessBlockResult getBucketPublicAccessBlockResult =
                obsClient.getBucketPublicAccessBlock(getBucketPublicAccessBlockRequest);
            BucketPublicAccessBlock bucketPublicAccessBlock =
                getBucketPublicAccessBlockResult.getBucketPublicAccessBlock();

            if (bucketPublicAccessBlock != null) {
                Boolean blockPublicACLs = bucketPublicAccessBlock.getBlockPublicACLs();
                Boolean blockPublicPolicy = bucketPublicAccessBlock.getBlockPublicPolicy();
                Boolean ignorePublicACLs = bucketPublicAccessBlock.getIgnorePublicACLs();
                Boolean restrictPublicBuckets = bucketPublicAccessBlock.getRestrictPublicBuckets();
                if (blockPublicACLs != null) {
                    System.out.println("GetBucketPublicAccessBlock BlockPublicACLs:" + blockPublicACLs);
                }
                if (blockPublicPolicy != null) {
                    System.out.println("GetBucketPublicAccessBlock BlockPublicPolicy:" + blockPublicPolicy);
                }
                if (ignorePublicACLs != null) {
                    System.out.println("GetBucketPublicAccessBlock IgnorePublicACLs:" + ignorePublicACLs);
                }
                if (restrictPublicBuckets != null) {
                    System.out.println("GetBucketPublicAccessBlock RestrictPublicBuckets:" + restrictPublicBuckets);
                }
            } else {
                System.out.println("GetBucketPublicAccessBlock bucketPublicAccessBlock is null.");
            }
            System.out.println("GetBucketPublicAccessBlock successfully");
        } catch (ObsException e) {
            System.out.println("GetBucketPublicAccessBlock failed");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            Map<String, String> headers = e.getResponseHeaders();// Check Map entries and print all headers associated with the error.
            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("GetBucketPublicAccessBlock failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}

Helpful Links

• Obtaining the BPA Configuration of a Bucket
• OBS Error Codes
• FAQ for Buckets and Objects