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

获取桶的BPA配置(Go SDK)

功能说明

获取OBS桶的PublicAccessBlock配置。

接口约束

  • 您必须是桶拥有者或拥有获取桶的BPA配置的权限，才能获取桶的BPA配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketPublicAccessBlock权限，如果使用桶策略则需授予GetBucketPublicAccessBlock权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。

方法定义

func (obsClient ObsClient) GetBucketPublicAccessBlock(input *GetBucketPublicAccessBlockInput) (output *BaseModel, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*GetBucketPublicAccessBlockInput

必选

参数解释：

获取桶的BPA配置的请求参数，详见GetBucketPublicAccessBlockInput。
表2 GetBucketPublicAccessBlockInput

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

返回结果说明

表3 返回结果列表

参数名称

参数类型

描述

output

*BaseModel

参数解释：

接口返回信息，详情参考BaseModel。

err

error

参数解释：

接口返回错误信息。
表4 BaseModel

参数名称

参数类型

描述

statusCode

int

参数解释：

HTTP状态码。

取值范围：

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

完整的状态码列表请参见状态码。

默认取值：

无

BlockPublicAcls

Boolean

参数解释：

是否锁定公共ACL，当该参数为True时，上传对象，设置Public ACL时禁止对象上传，ACL修改API（修改桶ACL、对象ACL），设置Public ACL时禁止ACL修改。

约束限制：

无

取值范围：

  • True：锁定公共ACL。
  • Fasle：不锁定公共ACL。

默认取值：

无

IgnorePublicAcls

Boolean

参数解释：

是否忽略公共ACL。当该参数为True时，OBS所有OpenAPI进行权限检查时，Public ACL不生效。

约束限制：

无

取值范围：

  • True：忽略公共ACL。
  • False：不忽略公共ACL。

默认取值：

无

BlockPublicPolicy

Boolean

参数解释：

是否锁定公共策略。当该参数为True时，桶策略修改API，设置Public Policy时禁止Policy修改。

约束限制：

无

取值范围：

  • True：锁定公共策略。
  • False：不锁定公共策略

默认取值：

无

RestrictPublicBuckets

Boolean

参数解释：

是否限制账号访问。当该参数为True时，OBS所有OpenAPI进行权限检查时，如果桶策略状态为公开，则只允许云服务账号和本账号访问

约束限制：

无

取值范围：

  • True：限制账号访问。
  • False：不限制账号访问

默认取值：

无

代码示例

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

package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html。
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。
    securityToken := os.Getenv("SecurityToken")
    // endpoint填写Bucket对应的Endpoint, 这里以中国-香港为例，其他地区请按实际情况填写。
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // 创建obsClient实例
    // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
    obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    // 指定存储桶名称
    bucketName := "examplebucket"
    // 获取桶的PublicAccessBlock配置
    output, err := obsClient.GetBucketPublicAccessBlock(bucketName)
    if err == nil {
	fmt.Printf("Get bucket(%s)'s PublicAccessBlock successful!\n", bucketName)
	fmt.Printf("RequestId:%s\n", output.RequestId)
	return
    }
    fmt.Printf("Get bucket(%s)'s PublicAccessBlock fail!\n", bucketName)
    if obsError, ok := err.(obs.ObsError); ok {
	fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
	fmt.Println(obsError.Error())
    } else {
	fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
	fmt.Println(err)
    }
}