九游平台/ 对象存储服务 obs/ sdk参考/ / / 创建桶(python sdk)
更新时间：2024-11-13 gmt 08:00

创建桶(python sdk)-九游平台

功能介绍

obs桶是对象的容器，您上传的文件都将以对象的形式存放在桶中。本文介绍如何使用python sdk创建桶。

调用创建桶接口，将在当前账号按照用户指定的桶名创建一个新桶，接口支持根据用户诉求，在创建桶的同时配置桶的存储类别、区域及桶的访问权限等参数。

接口约束

  • 您必须拥有obs:bucket:createbucket权限，才能创建桶。建议使用iam进行授权，配置方式详见。
  • obs支持的region以及region与endpoint的对应关系，详细信息请参见。

    创建桶时，如果初始化客户端使用的终端节点（endpoint）为“obs.myhuaweicloud.com”，则可以不指定桶所在区域（location），系统会自动在华北-北京一（cn-north-1）创建桶；如果初始化客户端使用的终端节点（endpoint）不是obs.myhuaweicloud.com，则必须指定桶所在区域（location），且指定的区域必须与终端节点（endpoint）区域一致，否则会返回状态码400。

    比如初始化时使用的终端节点endpoint是obs.cn-north-4.myhuaweicloud.com，那么在创建桶的时候必须指定location：cn-north-4才会创建成功。

  • 同一账号下，可以创建多个存桶，数量上限是100个（不区分地域），存储桶中的对象数量和大小没有限制。
  • 新创建桶的桶名在obs中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回http状态码200。除此以外的其他场景重复创建同名桶返回http状态码409，表明桶已存在。
  • 用户删除桶后，需要等待30分钟才能创建同名桶和并行文件系统。

方法定义

obsclient.createbucket(bucketname, header, location, extensionheaders)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketname

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用类ip地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。

默认取值：

无

header

createbucketheader

可选

参数解释：

创建桶的头域，用于设置桶的基本信息，包括存储类别、冗余策略等。

取值范围：

参考createbucketheader。

默认取值：

无

location

str

如果请求的obs服务地址所在区域为默认区域，则可为空，否则为必选。

参数解释：

桶所在的区域。

约束限制：

该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。

取值范围：

当前有效的obs区域和终端节点的更多信息，请参考。终端节点即调用api的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。

默认取值：

终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。

extensionheaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考。

默认取值：

无
表2 createbucketheader

参数名称

参数类型

是否必选

描述

aclcontrol

str

可选

参数解释：

创桶时可指定的预定义访问策略。

取值范围：

您可以选择预定义访问策略中任一个访问策略。

默认取值：

private，即私有权限。

storageclass

str

可选

参数解释：

创桶时可指定的桶的存储类型。

取值范围：

创桶时可指定的桶的存储类型。

默认取值：

standard，即标准存储类型。

extensiongrants

list of extensiongrant

可选

参数解释：

创桶时可指定的扩展权限列表。

取值范围：

参考extensiongrant。

默认取值：

无

availablezone

str

可选

参数解释：

创桶时可指定的数据冗余类型，即az类型。

约束限制：

归档存储和深度归档存储不支持多az。如果桶所在区域不支持多az存储，则该桶的存储类型默认为单az。

取值范围：

如果将桶配置为多az，则取值为3az。如果将桶配置为单az，则无需选择此选项，系统默认赋值。

默认取值：

不设置该参数，则默认设置桶为单az。

epid

str

可选

参数解释：

创桶时可指定的企业项目id，开通企业项目的用户可以从企业项目服务获取。

约束限制：

epid格式为uuid，未开通企业项目的用户可以不带该头域。

示例：9892d768-2d13-450f-aac7-ed0e44c2585f

取值范围：

获取方式参见如何获取企业项目id 。

默认取值：

无

ispfs

bool

可选

参数解释：

是否创建并行文件系统。

取值范围：

  • true：创建并行文件系统
  • false：创建桶

默认取值：

false，即创建桶
表3 headpermission

常量名

原始值

说明

headpermission.private

private

私有读写。

桶或对象的所有者拥有完全控制的权限，其他任何人都没有访问权限。

headpermission.public_read

public-read

公共读私有写。

设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。

设在对象上，所有人可以获取该对象内容和元数据。

headpermission.public_read_write

public-read-write

公共读写。

设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务。

设在对象上，所有人可以获取该对象内容和元数据。

headpermission.public_read_delivered

public-read-delivered

桶公共读，桶内对象公共读。

设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本，可以获取该桶内对象的内容和元数据。

说明：

public_read_delivered不能应用于对象。

headpermission.public_read_write_delivered

public-read-write-delivered

桶公共读写，桶内对象公共读写。

设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务，可以获取该桶内对象的内容和元数据。

说明：

public_read_write_delivered不能应用于对象。

headpermission.bucket_owner_full_control

public-read-write-delivered

设在对象上，桶和对象的所有者拥有对象的完全控制权限，其他任何人都没有访问权限。默认情况下，上传对象至其他用户的桶中，桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后，桶所有者可以完全控制对象。例如，用户a上传对象x至用户b的桶中，系统默认用户b没有对象x的控制权。当用户a为对象x设置bucket-owner-full-control策略后，用户b就拥有了对象x的控制权。
表4 storageclass

参数名称

参数类型

描述

standard

标准存储

参数解释：

标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1mb），且需要频繁访问数据的业务场景。

warm

低频访问存储

参数解释：

低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。

cold

归档存储

参数解释：

归档存储适用于很少访问（平均一年访问一次）数据的业务场景。

deep_archive

深度归档存储（受限公测）

参数解释：

深度归档存储适用于长期不访问（平均几年访问一次）数据的业务场景。
表5 extensiongrant

参数名称

参数类型

是否必选

描述

granteeid

str

可选

参数解释：

被授权用户的账号id，即domain_id。

取值范围：

如何获取账号id请参见

默认取值：

无

permission

str

可选

参数解释：

授予桶的自定义权限。

取值范围：

取值范围详见权限，您可以选择权限中的一个或多个权限对桶进行配置。

默认取值：

无
表6 permission

常量值

说明

read

读权限。

如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。

如果有对象的读权限，则可以获取该对象内容和元数据。

write

写权限。

如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。

此权限在对象上不适用。

read_acp

读取acl配置的权限。

如果有读acp的权限，则可以获取对应的桶或对象的权限控制列表（acl）。

桶或对象的所有者永远拥有读对应桶或对象acp的权限。

write_acp

修改acl配置的权限。

如果有写acp的权限，则可以更新对应桶或对象的权限控制列表（acl）。

桶或对象的所有者永远拥有写对应桶或对象的acp的权限。

拥有了写acp的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。

full_control

完全控制权限，包括对桶或对象的读写权限，以及对桶或对象acl配置的读写权限。

如果有桶的完全控制权限意味着拥有read、write、read_acp和write_acp的权限。

如果有对象的完全控制权限意味着拥有read、read_acp和write_acp的权限。

返回结果说明

表7 返回结果

类型

说明

getresult

参数解释：

sdk公共结果对象。
表8 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的桶，并设置所在区域在华北-北京四（cn-north-4），桶的权限访问控制策略是私有桶，存储类型是低频访问存储，多az方式存储。

 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
35
36
 
from obs import createbucketheader, headpermission
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:
    # 创建桶的附加头域，桶的访问控制策略是私有桶，存储类型是标准访问存储，多az方式存储
    header = createbucketheader(aclcontrol=headpermission.private, storageclass="standard", availablezone="3az")
    # 指定存储桶所在区域，此处以“cn-north-4”为例，必须跟传入的endpoint中region保持一致
    location = "cn-north-4"
    bucketname = "examplebucket"
    # 创建桶
    resp = obsclient.createbucket(bucketname, header, location)
    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('create bucket succeeded')
        print('requestid:', resp.requestid)
    else:
        print('create bucket failed')
        print('requestid:', resp.requestid)
        print('errorcode:', resp.errorcode)
        print('errormessage:', resp.errormessage)
except:
    print('create bucket failed')
    print(traceback.format_exc())

相关链接

  • 关于创建桶的api说明，请参见创建桶。
  • 更多关于创建桶的示例代码，请参见。
  • 创建桶过程中返回的错误码含义、问题原因及处理措施可参考obs错误码。
  • 创建桶常见问题请参见创建桶失败。
父主题：

相关文档

网站地图