创建桶(Python SDK)
功能介绍
OBS桶是对象的容器,您上传的文件都将以对象的形式存放在桶中。本文介绍如何使用Python SDK创建桶。
调用创建桶接口,将在当前账号按照用户指定的桶名创建一个新桶,接口支持根据用户诉求,在创建桶的同时配置桶的存储类别、区域及桶的访问权限等参数。
接口约束
- 您必须拥有obs:bucket:CreateBucket权限,才能创建桶。建议使用IAM进行授权,配置方式详见使用IAM自定义策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
创建桶时,如果初始化客户端使用的终端节点(endPoint)为“obs.myhuaweicloud.com”,则可以不指定桶所在区域(location),系统会自动在华北-北京一(cn-north-1)创建桶;如果初始化客户端使用的终端节点(endPoint)不是obs.myhuaweicloud.com,则必须指定桶所在区域(location),且指定的区域必须与终端节点(endPoint)区域一致,否则会返回状态码400。
比如初始化时使用的终端节点endPoint是obs.ap-southeast-1.myhuaweicloud.com,那么在创建桶的时候必须指定Location:ap-southeast-1才会创建成功。
- 同一账号下,可以创建多个存桶,数量上限是100个(不区分地域),存储桶中的对象数量和大小没有限制。
- 新创建桶的桶名在OBS中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回HTTP状态码200。除此以外的其他场景重复创建同名桶返回HTTP状态码409,表明桶已存在。
- 用户删除桶后,需要等待30分钟才能创建同名桶和并行文件系统。
方法定义
ObsClient.createBucket(bucketName, header, location)
请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketName |
str |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
header |
可选 |
参数解释: 创建桶的头域,用于设置桶的基本信息,包括存储类别、冗余策略等。 取值范围: 默认取值: 无 |
|
location |
str |
如果请求的OBS服务地址所在区域为默认区域,则可为空,否则为必选。 |
参数解释: 桶所在的区域。 约束限制: 该参数定义了桶将会被创建在哪个区域,如果使用的终端节点是obs.myhuaweicloud.com,可以不携带此参数;如果使用的终端节点不是obs.myhuaweicloud.com,则必须携带此参数。 取值范围: 当前有效的OBS区域和终端节点的更多信息,请参考地区和终端节点。终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以向企业管理员获取区域和终端节点信息。 默认取值: 终端节点为obs.myhuaweicloud.com且用户未设定区域时,默认为华北-北京一(cn-north-1)。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
aclControl |
str |
可选 |
参数解释: 创桶时可指定的预定义访问策略。 取值范围: 您可以选择预定义访问策略中任一个访问策略。 默认取值: PRIVATE,即私有权限。 |
storageClass |
str |
可选 |
参数解释: 创桶时可指定的桶的存储类型。 取值范围: 创桶时可指定的桶的存储类型。 默认取值: STANDARD,即标准存储类型。 |
extensionGrants |
list of ExtensionGrant |
可选 |
参数解释: 创桶时可指定的扩展权限列表。 取值范围: 默认取值: 无 |
availableZone |
str |
可选 |
参数解释: 创桶时可指定的数据冗余类型,即AZ类型。 约束限制: 归档存储不支持多AZ。如果桶所在区域不支持多AZ存储,则该桶的存储类型默认为单AZ。 取值范围: 如果将桶配置为多AZ,则取值为3az。如果将桶配置为单AZ,则无需选择此选项,系统默认赋值。 默认取值: 不设置该参数,则默认设置桶为单AZ。 |
epid |
str |
可选 |
参数解释: 创桶时可指定的企业项目ID,开通企业项目的用户可以从企业项目服务获取。 约束限制: Epid格式为uuid,未开通企业项目的用户可以不带该头域。 示例:9892d768-2d13-450f-aac7-ed0e44c2585f 取值范围: 获取方式参见如何获取企业项目ID 。 默认取值: 无 |
isPFS |
bool |
可选 |
参数解释: 是否创建并行文件系统。 取值范围:
默认取值: False,即创建桶 |
常量名 |
原始值 |
说明 |
---|---|---|
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的控制权。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
STANDARD |
标准存储 |
参数解释: 标准存储拥有低访问时延和较高的吞吐量,适用于有大量热点对象(平均一个月多次)或小对象(<1MB),且需要频繁访问数据的业务场景。 |
WARM |
低频访问存储 |
参数解释: 低频访问存储适用于不频繁访问(平均一年少于12次)但在需要时也要求能够快速访问数据的业务场景。 |
COLD |
归档存储 |
参数解释: 归档存储适用于很少访问(平均一年访问一次)数据的业务场景。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
granteeId |
str |
可选 |
参数解释: 被授权用户的账号ID,即domain_id。 取值范围: 如何获取账号ID请参见如何获取账号ID和用户ID? 默认取值: 无 |
permission |
str |
可选 |
参数解释: 授予桶的自定义权限。 取值范围: 取值范围详见权限,您可以选择权限中的一个或多个权限对桶进行配置。 默认取值: 无 |
常量值 |
说明 |
---|---|
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的权限。 |
返回结果说明
类型 |
说明 |
---|---|
参数解释: SDK公共结果对象。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
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的桶,并设置所在区域在中国-香港(ap-southeast-1),桶的权限访问控制策略是私有桶,存储类型是低频访问存储,多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 37 38 |
from obs import CreateBucketHeader, HeadPermission from obs import ObsClient import os import traceback # 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 # 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.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") # 指定存储桶所在区域,此处以“ap-southeast-1”为例,必须跟传入的Endpoint中Region保持一致。 location = "ap-southeast-1" 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()) |