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

功能介绍

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

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

接口约束

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

方法定义

ObsClient.setBucketQuota(bucketName, quota)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释

桶名。

约束限制:

桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
桶命名规则如下:

3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
禁止使用IP地址。
禁止以“-”或“.”开头及结尾。
禁止两个“.”相邻(如:“my..bucket”)。
禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。

同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

默认取值:

quota

int

必选

参数解释:

桶的配额值。

取值范围:

大于等于0的整型数,单位:字节。

默认取值:

0,表示没有限制桶配额。

返回结果说明

表2 返回结果

类型

说明

GetResult

参数解释:

SDK公共结果对象。

表3 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的桶配额为1GB。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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"
    # 指定指定桶的配额值,此处以1G为例,单位为字节
    quota = 1024 * 1024 * 1024
    # 设置桶配额
    resp = obsClient.setBucketQuota(bucketName, quota)

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

相关链接

关于设置桶配额的API说明,请参见设置桶配额。
更多关于设置桶配额的示例代码,请参见Github示例。
设置桶配额过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
桶和对象相关常见问题请参见桶和对象相关常见问题。

父主题: 桶相关接口

同意关联代理商云淘科技,购买华为云产品更优惠(QQ 78315851)

内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家