Help Center/ Object Storage Service/ SDK Reference/ Java/ Bucket Management (SDK for Java)/ Obtaining the BPA Configuration of a Bucket (SDK for Java)
Updated on 2025-07-29 GMT+08:00

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

Method

obsClient.getBucketPublicAccessBlock(GetBucketPublicAccessBlockRequest request )

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

GetBucketPublicAccessBlockRequest

Yes

Explanation:

Request parameters for obtaining the PublicAccessBlock configuration of a bucket. For details, see Table 2.

Table 2 GetBucketPublicAccessBlockRequest

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

String

Yes

Explanation:

Bucket name.

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets with the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Default value:

None

Responses

Table 3 GetBucketPublicAccessBlockResult

Parameter

Type

Description

statusCode

int

Explanation:

HTTP status code.

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors).

For more information, see Status Code.

Default value:

None

responseHeaders

Map<String, Object>

Explanation:

HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header.

Default value:

None

bucketPublicAccessBlock

BucketPublicAccessBlock

Explanation:

PublicAccessBlock configuration of a bucket

Restrictions:

None

Value range:

None

Default value:

None

Code Examples

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 details.
            e.printStackTrace();
        }
    }
}