All Products
Search
Document Center

Object Storage Service:GetBucketPublicAccessBlock

Last Updated:Apr 28, 2024

Queries the Block Public Access configurations of a bucket.

Usage notes

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

Request syntax

GET /?publicAccessBlock HTTP/1.1
Date: GMT Date
Content-Length: ContentLength
Content-Type: application/xml
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

Request headers

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

Response headers

The response to a GetBucketPublicAccessBlock request contains only common response headers. For more information, see Common response headers.

Response elements

Element

Type

Example

Description

PublicAccessBlockConfiguration

Container

N/A

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

Parent nodes: none

Child nodes: BlockPublicAccess

BlockPublicAccess

Boolean

true

Indicates whether Block Public Access is enabled for the bucket.

  • true: Block Public Access is enabled.

  • false: Block Public Access is disabled.

Examples

  • Sample request

    GET /?publicAccessBlock HTTP/1.1
    Date: Mon, 19 Feb 2024 08:40:17 GMT
    Content-Length: 0
    Content-Type: application/xml
    Host: examplebucket.oss-cn-hangzhou.aliyuncs.com
    Authorization: OSS qn6q**************:77Dv****************
  • Sample success response

    HTTP/1.1 200 OK
    x-oss-request-id: 534B371674E88A4D8906****
    Date: Mon, 19 Feb 2024 08:40:17 GMT
    Server: AliyunOSS
    
    <?xml version="1.0" encoding="UTF-8"?>
    <PublicAccessBlockConfiguration>
      <BlockPublicAccess>true</BlockPublicAccess>
    </PublicAccessBlockConfiguration>