Call the PutAccessPointPublicAccessBlock operation to enable Block Public Access for an access point - Object Storage Service

Usage notes

An Alibaba Cloud account has the permissions to enable Block Public Access for an access point by default. To perform this operation as a RAM user or by using Security Token Service (STS) credentials, you must have the oss:PutAccessPointPublicAccessBlock permission. For more information, see Common examples of RAM policies.
When Block Public Access is enabled, all existing public access permissions are ignored and no new public access permissions can be configured. When Block Public Access is disabled, existing public access permissions take effect and can be configured.

Request syntax

PUT /?publicAccessBlock&x-oss-access-point-name=ap-01 HTTP/1.1
Date: GMT Date
Content-Length: ContentLength
Content-Type: application/xml
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

<?xml version="1.0" encoding="UTF-8"?>
<PublicAccessBlockConfiguration>
  <BlockPublicAccess>true</BlockPublicAccess>
</PublicAccessBlockConfiguration>

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request elements

Element	Type	Required	Example	Description
x-oss-access-point-name	String	Yes	ap-01	The name of the access point.
PublicAccessBlockConfiguration	Container	Yes	N/A	The container that stores the Block Public Access configurations. Parent nodes: none Child nodes: BlockPublicAccess
BlockPublicAccess	Boolean	No	true	Specifies whether to enable Block Public Access for the access point. true: enables Block Public Access. false (default): disables Block Public Access.

Response headers

This operation returns only common response headers. For more information, see Common response headers.

Examples

Sample request

PUT /?publicAccessBlock&x-oss-access-point-name=ap-01 HTTP/1.1
Date: Mon, 19 Feb 2024 08:40:17 GMT
Content-Length: 148
Content-Type: application/xml
Host: examplebucket.oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

<?xml version="1.0" encoding="UTF-8"?>
<PublicAccessBlockConfiguration>
  <BlockPublicAccess>true</BlockPublicAccess>
</PublicAccessBlockConfiguration>

Sample success response

HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Mon, 19 Feb 2024 08:40:17 GMT
Server: AliyunOSS

OSS SDKs

You can call PutAccessPointPublicAccessBlock by using OSS SDKs for the following programming languages:

ossutil

For the ossutil command that corresponds to this operation, see put-access-point-public-access-block.