Obtaining the Public Access Status of a Bucket

Functions

This API obtains the public access status of an OBS bucket.

To perform this operation, you must have the GetBucketPublicStatus permission. The bucket owner can perform this operation by default and can grant this permission to others by using a bucket policy or a user policy.

Authorization Information

To call this API, you must be the bucket owner or have the permission to obtain the public access status of a bucket. You are advised to use IAM or bucket policies for authorization. For details about OBS authorization methods, see Differences Between OBS Permissions Control Methods.

• If you use IAM for authorization, you need to use either role/policy-based authorization or identity policy-based authorization and configure the required permissions:
  • If you use role/policy-based authorization (IAM v3 APIs in the old IAM version), you need to grant the obs:bucket:GetBucketPublicStatus permission. For details, see Creating a Custom IAM Policy.
  • If you use identity policy-based authorization (IAM v5 APIs in the new IAM version), you need to grant the obs:bucket:getBucketPublicStatus permission, as shown in the following table. For details, see Creating a Custom IAM Identity Policy.

    Action	Access Level	Resource Type (*: Required)	Condition Key	Alias	Dependencies
    obs:bucket:getBucketPublicStatus	Read	bucket *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-
    		-	obs:EpochTime obs:SourceIp obs:TlsVersion obs:CustomDomain

• If you use bucket policies for authorization, you need to grant the obs:bucket:GetBucketPublicStatus permission. For details, see Creating a Custom Bucket Policy.

Request Syntax

GET /?bucketStatus HTTP/1.1
Host: bucketname.obs.region.myhuaweicloud.com 
Date: date
Authorization: authorization
Content-Type: application/xml
Content-Length: length

Request Parameters

This request contains no parameters.

Request Headers

This request uses common headers. For details, see Table 3.

Request Elements

The request contains no elements.

Response Syntax

HTTP/1.1 status_code
Date: date
x-obs-request-id: 000001934E7A99E2530672D3A3903140
x-obs-id-2: 36AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAaI=AAAAAAAAAAAAAAAAAAAAAAAAAA
Content-Length: length

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BucketStatus xmlns="http://obs.myhwclouds.com/doc/2015-06-30/">
  <IsPublic>boolean</IsPublic>
</BucketStatus>

Response Headers

This response uses common headers. For details, see Table 1.

Response Elements

This response contains elements to specify the public access status of the bucket. Table 1 describes the elements.

Error Responses

Table 2 describes possible special errors in this request.

For other errors, see Table 2.

Sample Request

GET /?bucketStatus HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.myhuaweicloud.com
Accept: */*
Date: Sat, 16 Nov 2024 08:59:07 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw=

Sample Response

HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016435CE298386946AE4C482
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
Date: Sat, 16 Nov 2024 08:59:08 GMT
Content-Length: 160

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BucketStatus xmlns="http://obs.myhwclouds.com/doc/2015-06-30/">
  <IsPublic>false</IsPublic>
</BucketStatus>