文档首页/ 对象存储服务 OBS/ API参考/ API/ 桶的高级配置/ 获取桶级阻止公共访问配置-GetBucketPublicAccessBlock
更新时间:2025-12-18 GMT+08:00
分享

获取桶级阻止公共访问配置-GetBucketPublicAccessBlock

功能介绍

获取OBS桶的PublicAccessBlock配置。

要正确执行此操作,需要确保操作者有GetBucketPublicAccessBlock权限。默认情况下只有桶的所有者可以执行此操作,也可以通过设置桶策略或用户策略授权给其他用户。

授权信息

您必须是桶拥有者或拥有获取桶级阻止公共访问配置的权限,才能调用本接口,建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别

  • 如果使用IAM授权,那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种,并配置相应权限:
    • 如果使用角色与策略授权(旧版IAM,即IAM v3接口),需具备obs:bucket:GetBucketPublicAccessBlock权限,授权操作请参见创建IAM自定义策略
    • 如果使用身份策略授权(新版IAM,即IAM v5接口),如下表所示,需具备obs:bucket:getBucketPublicAccessBlock权限,授权操作请参见创建IAM自定义身份策略

      授权项

      Action

      访问级别

      Access Level

      资源类型(*为必须)

      Resource Type (*: required)

      条件键

      Condition Key

      别名

      Alias

      依赖的授权项

      Dependencies

      obs:bucket:getBucketPublicAccessBlock

      Read

      bucket *

      -

      -

      -

      • obs:EpochTime
      • obs:SourceIp
      • obs:TlsVersion
      • obs:CustomDomain
  • 如果使用桶策略进行授权,需具备obs:bucket:GetBucketPublicAccessBlock权限,具体操作请参见自定义创建桶策略

请求消息样式

GET /?publicAccessBlock HTTP/1.1
Host: bucketname.obs.cn-north-4.myhuaweicloud.com
Date: date
Authorization: authorization
Content-Type: application/xml
Content-Length: length

请求消息参数

该请求消息中不使用消息参数。

请求消息头

该请求使用公共消息头,具体参见表3

请求消息元素

该请求消息中不使用消息元素。

响应消息样式

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"?>
<PublicAccessBlockConfiguration xmlns="http://obs.myhwclouds.com/doc/2015-06-30/">
  <BlockPublicAcls>boolean</BlockPublicAcls>
  <IgnorePublicAcls>boolean</IgnorePublicAcls>
  <BlockPublicPolicy>boolean</BlockPublicPolicy>
  <RestrictPublicBuckets>boolean</RestrictPublicBuckets>
</PublicAccessBlockConfiguration>

响应消息头

该请求的响应消息使用公共消息头,具体请参考表1

响应消息元素

该请求的响应中以消息元素的形式返回桶的阻止公开访问信息,元素的具体意义如表1所示。

表1 响应消息元素

元素名称

元素类型

描述

PublicAccessBlockConfiguration

XML

参数解释:

桶阻止公开访问配置。

BlockPublicAcls

Boolean

参数解释:

指定是否应该禁止为桶或桶内对象配置公开的ACL(access control list)。如果指定为true,会出现以下现象:

  • 上传对象时,如果指定公开的ACL,则上传对象失败,返回403 Access Denied。
  • 修改桶ACL或对象ACL时,如果指定公开的ACL,则修改ACL失败,返回403 Access Denied。

取值范围:

  • true:开启
  • false:关闭

IgnorePublicAcls

Boolean

参数解释:

指定是否需要忽略已经为桶或桶内对象配置的公开的ACL。如果指定为true,该桶或桶内对象公开的ACL均会失效。

取值范围:

  • true:开启
  • false:关闭

BlockPublicPolicy

Boolean

参数解释:

指定是否应该禁止为桶配置公开的桶策略。如果指定为true,为桶配置桶策略时,如果指定公开的桶策略,则配置桶策略失败,返回403 Access Denied。

取值范围:

  • true:开启
  • false:关闭

RestrictPublicBuckets

Boolean

参数解释:

指定是否需要对已有的公开桶策略进行限制。如果指定为true并且桶策略为公开时,只允许云服务账号和桶拥有者账号对该桶访问。

取值范围:

  • true:开启
  • false:关闭

错误响应消息

此请求可能的特殊错误如下表2描述。

表2 错误响应消息

错误码

描述

HTTP状态码

MethodNotAllowed

不允许使用该方法(特性开关未开启)

405

其余错误已经包含在表2中。

请求示例

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

响应示例

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: 348

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PublicAccessBlockConfiguration xmlns="http://obs.myhwclouds.com/doc/2015-06-30/">
  <BlockPublicAcls>false</BlockPublicAcls>
  <IgnorePublicAcls>false</IgnorePublicAcls>
  <BlockPublicPolicy>false</BlockPublicPolicy>
  <RestrictPublicBuckets>false</RestrictPublicBuckets>
</PublicAccessBlockConfiguration>

相关文档