设置桶的BPA配置
功能说明
创建或修改OBS桶的PublicAccessBlock配置,以开启或关闭阻止公开访问。
接口约束
- 您必须是桶拥有者或拥有设置桶BPA配置的权限,才能设置桶桶BPA配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:PutBucketPublicAccessBlock权限,如果使用桶策略则需授予PutBucketPublicAccessBlock权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
- 如果开启阻止公开访问,则已有的公开访问权限会被忽略,并且不允许配置新的公开访问权限。如果关闭阻止公开访问,则已有的公开访问权限仍然生效,并且支持配置新的公开访问权限。
- Posix桶新桶默认不开启BPA配置,对象桶新桶默认开启BPA配置。
方法定义
ObsClient.putBucketPublicAccessBlock(params)
设置桶的BPA配置请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | String | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| BlockPublicAcls | bool | 可选 | 参数解释: 是否锁定公共ACL,当该参数为True时,上传对象,设置Public ACL时禁止对象上传,ACL修改API(修改桶ACL、对象ACL),设置Public ACL时禁止ACL修改。 约束限制: 无 取值范围:
默认取值: 无 |
| IgnorePublicAcls | bool | 可选 | 参数解释: 是否忽略公共ACL。当该参数为True时,OBS所有OpenAPI进行权限检查时,Public ACL不生效。 约束限制: 无 取值范围:
默认取值: 无 |
| BlockPublicPolicy | bool | 可选 | 参数解释: 是否锁定公共策略。当该参数为True时,桶策略修改API,设置Public Policy时禁止Policy修改。 约束限制: 无 取值范围:
默认取值: 无 |
| RestrictPublicBuckets | bool | 可选 | 参数解释: 是否限制账号访问。当该参数为True时,OBS所有OpenAPI进行权限检查时,如果桶策略状态为公开,则只允许云服务账号和本账号访问 约束限制: 无 取值范围:
默认取值: 无 |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
| Status | number | 参数解释: OBS服务端返回的HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 |
| Code | string | 参数解释: OBS服务端返回的错误码。 |
| Message | string | 参数解释: OBS服务端返回的错误描述。 |
| HostId | string | 参数解释: OBS服务端返回的请求服务端ID。 |
| RequestId | string | 参数解释: OBS服务端返回的请求ID。 |
| Id2 | string | 参数解释: OBS服务端返回的请求ID2。 |
| Indicator | string | 参数解释: OBS服务端返回的详细错误码。 |