设置桶的BPA配置(Node.js SDK)

功能说明

创建或修改OBS桶的PublicAccessBlock配置，以开启或关闭阻止公开访问。

开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。

接口约束

您必须是桶拥有者或拥有设置桶BPA配置的权限，才能设置桶桶BPA配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketPublicAccessBlock权限，如果使用桶策略则需授予PutBucketPublicAccessBlock权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
如果开启阻止公开访问，则已有的公开访问权限会被忽略，并且不允许配置新的公开访问权限。如果关闭阻止公开访问，则已有的公开访问权限仍然生效，并且支持配置新的公开访问权限。
Posix桶新桶默认不开启BPA配置，对象桶新桶默认开启BPA配置。

方法定义

ObsClient.putBucketPublicAccessBlock(params)

设置桶的BPA配置请求参数说明

表1 请求参数列表
参数名称	参数类型	是否必选	描述
bucketName	String	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
blockPublicAcls	bool	可选	参数解释：是否锁定公共ACL，当该参数为True时，上传对象，设置Public ACL时禁止对象上传，ACL修改API（修改桶ACL、对象ACL），设置Public ACL时禁止ACL修改。约束限制：无取值范围： True：锁定公共ACL。 False：不锁定公共ACL。默认取值：无
ignorePublicAcls	bool	可选	参数解释：是否忽略公共ACL。当该参数为True时，OBS所有OpenAPI进行权限检查时，Public ACL不生效。约束限制：无取值范围： True：忽略公共ACL。 False：不忽略公共ACL。默认取值：无
blockPublicPolicy	bool	可选	参数解释：是否锁定公共策略。当该参数为True时，桶策略修改API，设置Public Policy时禁止Policy修改。约束限制：无取值范围： True：锁定公共策略。 False：不锁定公共策略默认取值：无
restrictPublicBuckets	bool	可选	参数解释：是否限制账号访问。当该参数为True时，OBS所有OpenAPI进行权限检查时，如果桶策略状态为公开，则只允许云服务账号和本账号访问约束限制：无取值范围： True：限制账号访问。 False：不限制账号访问默认取值：无

返回结果说明

表2 返回结果
参数类型	描述
表3 说明：该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。	参数解释：接口返回信息，详见表3。

表3 Response
参数名称	参数类型	描述
CommonMsg	ICommonMsg	参数解释：接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。
InterfaceResult	表5	参数解释：操作成功后的结果数据，详见表5。约束限制：当Status大于300时为空。

表4 ICommonMsg
参数名称	参数类型	描述
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服务端返回的详细错误码。