设置桶的BPA配置(Go SDK)
功能说明
创建或修改OBS桶的PublicAccessBlock配置,以开启或关闭阻止公开访问。
接口约束
- 您必须是桶拥有者或拥有设置桶BPA配置的权限,才能设置桶桶BPA配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:PutBucketPublicAccessBlock权限,如果使用桶策略则需授予PutBucketPublicAccessBlock权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
- 如果开启阻止公开访问,则已有的公开访问权限会被忽略,并且不允许配置新的公开访问权限。如果关闭阻止公开访问,则已有的公开访问权限仍然生效,并且支持配置新的公开访问权限。
- Posix桶新桶默认不开启BPA配置,对象桶新桶默认开启BPA配置。
方法定义
func (obsClient ObsClient) PutBucketPublicAccessBlock(input *PutBucketPublicAccessBlockInput) (output *BaseModel, err error)
请求参数说明
|
参数名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
input |
必选 |
参数解释: 设置桶的BPA配置的请求参数,详见PutBucketPublicAccessBlockInput。 |
|
参数名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
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进行权限检查时,如果桶策略状态为公开,则只允许云服务账号和本账号访问 约束限制: 无 取值范围:
默认取值: 无 |
返回结果说明
|
参数名称 |
参数类型 |
描述 |
|---|---|---|
|
StatusCode |
int |
参数解释: HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值: 无 |
|
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 默认取值: 无 |
|
ResponseHeaders |
map[string][]string |
参数解释: HTTP响应头信息。 默认取值: 无 |
代码示例
本示例用于设置名为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))
obsClient, err := "https://your-endpoint"
if err != nil {
fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
}
input := &obs.PutBucketPublicAccessBlockInput{}
// 指定存储桶名称
input.Bucket = "examplebucket"
// 指定桶的PublicAccessBlock配置项
input.BlockPublicAcls = true
input.BlockPublicPolicy = true
input.IgnorePublicAcls = true
input.RestrictPublicBuckets = true
// 设置桶的PublicAccessBlock配置
output, err := obsClient.PutBucketPublicAccessBlock(input)
if err == nil {
fmt.Printf("Set bucket(%s)'s PublicAccessBlock successful!\n", input.Bucket)
fmt.Printf("RequestId:%s\n", output.RequestId)
return
}
fmt.Printf("Set bucket(%s)'s PublicAccessBlock fail!\n", input.Bucket)
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)
}
}