All Products
Search

This Product

    Object Storage Service:PutBucketPublicAccessBlock

    Document Center

    Object Storage Service:PutBucketPublicAccessBlock

    Last Updated:Apr 28, 2024

    Enables Block Public Access for a bucket.

    Usage notes

    • By default, an Alibaba Cloud account has the permissions to enable Block Public Access for a bucket. If you want to enable Block Public Access for a bucket by using a RAM user or the access credentials provided by Security Token Service (STS), you must have the oss:PutBucketPublicAccessBlock permission. For more information, see Common examples of RAM policies.

    • If you enable Block Public Access, existing public access permissions are ignored and you cannot configure public access permissions. If you disable Block Public Access, existing public access permissions take effect and you can configure public access permissions.

    Request syntax

    PUT /?publicAccessBlock 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

    All headers in a PutBucketPublicAccessBlock request are common request headers. For more information, see Common request headers.

    Request elements

    Element

    Type

    Required

    Example

    Description

    PublicAccessBlockConfiguration

    Container

    Yes

    N/A

    The container in which the Block Public Access configurations are stored.

    Parent nodes: none

    Child nodes: BlockPublicAccess

    BlockPublicAccess

    Boolean

    No

    true

    Specifies whether to enable Block Public Access for the bucket.

    • true: enables Block Public Access.

    • false (default): disables Block Public Access.

    Examples

    • Sample request

      PUT /?publicAccessBlock 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: OSS qn6q**************:77Dv****************

<?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