华为云对象存储OBS设置桶配额(Go SDK)_云淘科技

华为云云存储

11 月 24, 2023

109 0

功能介绍

桶配额是桶容量的上限值。默认情况下，OBS系统和单个桶都没有总数据容量和对象数量的限制。您可以根据需要，为桶设置配额限制来控制桶内允许上传的对象总容量，超过设置的对象容量后，上传对象会失败。例如您为桶设置配额为100G，那么当桶内所有对象的大小总和达到100G后，再上传对象就会因为超过配额导致上传失败。

容量限制只对桶配额设置生效后的对象上传操作有影响，如果您设置桶配额时，桶配额的数值小于桶中已上传的对象容量，并不会导致桶中已有对象被删除，但该桶后续将不能再上传任何对象。这种情况下只有删除部分已有对象，将已用空间释放到配额限制以下之后才能再次上传新对象。

接口约束

桶配额值必须为非负整数，单位为字节，支持的最大值为2⁶³-1。
OBS没有提供删除桶配额的接口，您可以将桶配额设置为0来取消配额限制。
您必须是桶拥有者或拥有设置桶配额的权限，才能设置桶配额。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketQuota权限，如果使用桶策略则需授予PutBucketQuota权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

func (obsClient ObsClient) SetBucketQuota(input *SetBucketQuotaInput, extensions…extensionOptions) (output *BaseModel, err error)

请求参数说明

表1 请求参数列表
参数名称	参数类型	是否必选	描述
input	*SetBucketQuotaInput	必选	参数解释：设置桶配额请求参数，详见SetBucketQuotaInput。
extensions	extensionOptions	可选	参数解释：桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。

表2 SetBucketQuotaInput
参数名称	参数类型	是否必选	描述
Bucket	string	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
Quota	int64	必选	参数解释：桶的配额值。取值范围： 0~（2⁶³-1），单位：字节。默认取值： 0，表示没有限制桶配额。

返回结果说明

表3 返回结果列表
参数名称	参数类型	描述
output	*BaseModel	参数解释：接口返回信息，详见BaseModel。
err	error	参数解释：接口返回错误信息。

表4 BaseModel
参数名称	参数类型	描述
StatusCode	int	参数解释： HTTP状态码。取值范围：状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。默认取值：无
RequestId	string	参数解释： OBS服务端返回的请求ID。默认取值：无
ResponseHeaders	map[string][]string	参数解释： HTTP响应头信息。默认取值：无

代码示例

本示例用于设置名为examplebucket的桶配额为1G

package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/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.cn-north-4.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())
    }
    input := &obs.SetBucketQuotaInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定指定桶的配额值，此处以1G为例，单位为字节
    input.Quota = 1024 * 1024 * 1024
    // 设置桶配额
    output, err := obsClient.SetBucketQuota(input)
    if err == nil {
        fmt.Printf("Set bucket(%s)'s quota successful!
", input.Bucket)
        fmt.Printf("RequestId:%s
", output.RequestId)
        return
    }
    fmt.Printf("Set bucket(%s)'s quota fail!
", 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)
    }
}