文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 设置桶的BPA配置(Python SDK)
更新时间：2025-05-09 GMT+08:00
查看PDF
分享

设置桶的BPA配置(Python SDK)

功能介绍

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

接口约束

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

方法定义

ObsClient.putBucketPublicAccessBlock(bucket, blockPublicAcls, ignorePublicAcls, blockPublicPolicy, restrictPublicBuckets)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 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：不限制账号访问

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无

返回结果说明

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表2 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

代码样例

本示例用于设置名为examplebucket的桶PublicAccessBlock配置。

from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    # 设置桶的PublicAccessBlock配置
    resp = obsClient.putBucketPublicAccessBlock(bucketName, blockPublicAcls=True, ignorePublicAcls=True,
                                                          blockPublicPolicy=True, restrictPublicBuckets=True)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Put Bucket PublicAccessBlock Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Put Bucket PublicAccessBlock Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Put Bucket PublicAccessBlock Failed')
    print(traceback.format_exc())

相关链接

  • 设置桶BPA配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。

相关文档