Help Center/ Object Storage Service/ SDK Reference/ Node.js/ Bucket APIs (SDK for Node.js)/ Block Public Access (BPA) (SDK for Node.js)/ Obtaining the BPA Configuration of a Bucket (SDK for Node.js)
Updated on 2026-07-22 GMT+08:00
View PDF
Share

Obtaining the BPA Configuration of a Bucket (SDK for Node.js)

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(params)

Request Parameters

Table 1 List of request parameters

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 a period (.) and a hyphen (-) 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 2 List of returned results

Type

Description

Table 3

NOTE:

This API returns a Promise response, which requires the Promise or async/await syntax.

Explanation:

Returned results. For details, see Table 3.
Table 3 Response

Parameter

Type

Description

CommonMsg

ICommonMsg

Explanation:

Common information generated after an API call is complete, including the HTTP status code and error code. For details, see Table 4.

InterfaceResult

Table 5

Explanation:

Results outputted for a successful call. For details, see Table 5.

Restrictions:

This parameter is not included if the value of Status is greater than 300.
Table 4 ICommonMsg

Parameter

Type

Description

Status

number

Explanation:

HTTP status code returned by the OBS server.

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 details, see Status Codes.

Code

string

Explanation:

Error code returned by the OBS server.

Message

string

Explanation:

Error description returned by the OBS server.

HostId

string

Explanation:

Request server ID returned by the OBS server.

RequestId

string

Explanation:

Request ID returned by the OBS server.

Id2

string

Explanation:

Request ID2 returned by the OBS server.

Indicator

string

Explanation:

Error code details returned by the OBS server.
Table 5 Parameters in the returned results of obtaining the BPA configuration of a bucket

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

BlockPublicAcls

Boolean

Explanation:

Whether to block public ACLs. If this parameter is set to True, objects cannot be uploaded when the request includes a public ACL. Requests for modifying bucket or object ACLs fail if the requests include public ACLs.

Restrictions:

None

Value range:

  • True: The public ACL is blocked.
  • False: The public ACL is not blocked.

Default value:

None

IgnorePublicAcls

Boolean

Explanation:

Whether to ignore public ACLs. If this parameter is set to True, the public ACL does not take effect during OpenAPI permissions checks.

Restrictions:

None

Value range:

  • True: The public ACL is ignored.
  • False: The public ACL is not ignored.

Default value:

None

BlockPublicPolicy

Boolean

Explanation:

Whether to block the public policy. If this parameter is set to True, OBS rejects calls to modify bucket policies if the specified bucket policy allows public access.

Restrictions:

None

Value range:

  • True: The public policy is blocked.
  • False: The public policy is not blocked.

Default value:

None

RestrictPublicBuckets

Boolean

Explanation:

Whether to restrict account access. If this parameter is set to True, only cloud service accounts and this account can access the bucket if a public bucket policy is found during the OpenAPI permissions check.

Restrictions:

None

Value range:

  • True: The account access is restricted.
  • False: The account access is not restricted.

Default value:

None