创建桶(go sdk)-九游平台
功能介绍
obs桶是对象的容器,您上传的文件都将以对象的形式存放在桶中。本文介绍如何使用go 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 才会创建成功,否则会返回状态码400。
- 同一账号下,可以创建多个存桶,数量上限是100个(不区分地域),存储桶中的对象数量和大小没有限制。
- 新创建桶的桶名在obs中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回http状态码200。除此以外的其他场景重复创建同名桶返回http状态码409,表明桶已存在。
- 用户删除桶后,需要等待30分钟才能创建同名桶和并行文件系统。
- 并不是所有区域都支持创建多az桶,您可以在页面,查询指定区域是否支持多az。
方法定义
func (obsclient obsclient) createbucket(input *createbucketinput, extensions...extensionoptions) (output *basemodel, err error)
请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
input |
是 |
参数解释: 创建桶接口入参,详见createbucketinput。 |
|
extensions |
否 |
参数解释: 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头,详见。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
location |
string |
如果请求的obs服务地址所在区域为默认区域,则可为空,否则为必选。 |
参数解释: 桶所在的区域。 约束限制: 该参数定义了桶将会被创建在哪个区域,如果使用的终端节点是obs.myhuaweicloud.com,可以不携带此参数;如果使用的终端节点不是obs.myhuaweicloud.com,则必须携带此参数。 取值范围: 当前有效的obs区域和终端节点的更多信息,请参考。终端节点即调用api的请求地址,不同服务不同区域的终端节点不同,您可以向企业管理员获取区域和终端节点信息。 默认取值: 终端节点为obs.myhuaweicloud.com且用户未设定区域时,默认为华北-北京一(cn-north-1)。 |
acl |
可选 |
参数解释: 创桶时可指定的预定义访问策略,有关访问控制列表(access control list,acl)功能的详细信息可参见acl功能介绍。 取值范围: 可选择的访问策略选项参见acltype。 默认取值: 私有权限 |
|
storageclass |
可选 |
参数解释: 创桶时可指定的桶的存储类型。 取值范围: 可选择的访问策略选项参见storageclasstype。 默认取值: 标准存储类型 |
|
grantreadid |
string |
可选 |
参数解释: 被授予read权限的账号的账号id,即domain_id。账号被授予read权限后,针对当前正在创建的桶,允许列举桶内对象、列举桶中多段任务、列举桶中多版本对象、获取桶元数据。 取值范围: 如何获取账号id请参见 默认取值: 无 |
grantwriteid |
string |
可选 |
参数解释: 被授予write权限的账号的账号id,即domain_id。账号被授予write权限后,针对当前正在创建的桶,允许创建、删除、覆盖桶内所有对象,允许初始化段、上传段、拷贝段、合并段、取消多段上传任务。 取值范围: 如何获取账号id请参见 默认取值: 无 |
grantreadacpid |
string |
可选 |
参数解释: 被授予read_acp权限的账号的账号id,即domain_id。账号被授予read_acp权限后,针对当前正在创建的桶,允许读桶的acl信息。 取值范围: 如何获取账号id请参见 默认取值: 无 |
grantwriteacpid |
string |
可选 |
参数解释: 被授予write_acp权限的账号的账号id,即domain_id。账号被授予write_acp权限后,针对当前正在创建的桶,允许修改桶的acl信息。 取值范围: 如何获取账号id请参见 默认取值: 无 |
grantfullcontrolid |
string |
可选 |
参数解释: 被授予full_control权限的账号的账号id,即domain_id。账号被授予full_control权限后,针对当前正在创建的桶,允许进行任何操作。 取值范围: 如何获取账号id请参见 默认取值: 无 |
grantreaddeliveredid |
string |
可选 |
参数解释: 被授予read权限的账号的账号id,即domain_id。授权指定账号有read权限,并且在默认情况下,该read权限将传递给桶内所有对象。 取值范围: 如何获取账号id请参见 默认取值: 无 |
grantfullcontroldeliveredid |
string |
可选 |
参数解释: 被授予full_control权限的账号的账号id,即domain_id。授权指定账号有当前桶的全部控制权限,并且在默认情况下,该full_control权限将传递给桶内所有对象。 取值范围: 如何获取账号id请参见 默认取值: 无 |
epid |
string |
可选 |
参数解释: 创桶时可指定的企业项目id,开通企业项目的用户可以从企业项目服务获取。 约束限制: epid格式为uuid,未开通企业项目的用户可以不带该头域。 示例:9892d768-2d13-450f-aac7-ed0e44c2585f 默认取值: 无 |
availablezone |
string |
可选 |
参数解释: 创桶时可指定的数据冗余类型,即az类型。 约束限制: 归档和深度归档存储不支持多az。如果桶所在区域如果不支持多az存储,则该桶的存储类型默认为单az。 取值范围: 如果将桶配置为多az,则取值为3az。如果将桶配置为单az,则无需选择此选项,系统默认赋值。 默认取值: 单az |
isfsfileinterface |
bool |
可选 |
参数解释: 是否创建并行文件系统。 取值范围:
默认取值: false,即创建桶 |
常量名 |
原始值 |
说明 |
---|---|---|
aclprivate |
private |
私有读写。 桶或对象的所有者拥有完全控制的权限,其他任何人都没有访问权限。 |
aclpublicread |
public-read |
公共读私有写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上,所有人可以获取该对象内容和元数据。 |
aclpublicreadwrite |
public-read-write |
公共读写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务。 设在对象上,所有人可以获取该对象内容和元数据。 |
aclpublicreaddelivered |
public-read-delivered |
桶公共读,桶内对象公共读。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本,可以获取该桶内对象的内容和元数据。
说明:
aclpublicreaddelivered不能应用于对象。 |
aclpublicreadwritedelivered |
public-read-write-delivered |
桶公共读写,桶内对象公共读写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务,可以获取该桶内对象的内容和元数据。
说明:
aclpublicreadwritedelivered不能应用于对象。 |
aclbucketownerfullcontrol |
bucket-owner-full-control |
设在对象上,桶和对象的所有者拥有对象的完全控制权限,其他任何人都没有访问权限。 默认情况下,上传对象至其他用户的桶中,桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后,桶所有者可以完全控制对象。例如,用户a上传对象x至用户b的桶中,系统默认用户b没有对象x的控制权。当用户a为对象x设置bucket-owner-full-control策略后,用户b就拥有了对象x的控制权。 |
常量名 |
原始值 |
说明 |
---|---|---|
storageclassstandard |
standard |
标准存储。 标准存储拥有低访问时延和较高的吞吐量,适用于有大量热点对象(平均一个月多次)或小对象(<1mb),且需要频繁访问数据的业务场景。 |
storageclasswarm |
warm |
低频访问存储。 低频访问存储适用于不频繁访问(平均一年少于12次)但在需要时也要求能够快速访问数据的业务场景。 |
storageclasscold |
cold |
归档存储。 归档存储适用于很少访问(平均一年访问一次)数据的业务场景。 |
storageclassdeeparchive |
deep_archive |
深度归档存储(受限公测) 适用于长期不访问(平均几年访问一次)数据的业务场景。 |
返回结果说明
参数名称 |
参数类型 |
描述 |
---|---|---|
statuscode |
int |
参数解释: http状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见。 默认取值: 无 |
requestid |
string |
参数解释: obs服务端返回的请求id。 默认取值: 无 |
responseheaders |
map[string][]string |
参数解释: http响应头信息。 默认取值: 无 |
代码示例
本示例用于创建名为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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
packagemain import( "fmt" "os" obs"github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) funcmain(){ //推荐通过环境变量获取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)*/) iferr!=nil{ fmt.printf("create obsclient error, errmsg: %s",err.error()) } input:=&obs.createbucketinput{} // 指定存储桶名称 input.bucket="examplebucket" // 指定存储桶所在区域,此处以“cn-north-4”为例,必须跟传入的endpoint中region保持一致。 input.location="cn-north-4" // 指定存储桶的权限控制策略,此处以obs.aclprivate为例。 input.acl=obs.aclprivate // 指定存储桶的存储类型,此处以obs.storageclasswarm为例。如果未指定该参数,则创建的桶为标准存储类型。 input.storageclass=obs.storageclasswarm // 指定存储桶的az类型,此处以“3az”为例。不携带时默认为单az,如果对应region不支持多az存储,则该桶的存储类型仍为单az。 input.availablezone="3az" // 创建桶 output,err:=obsclient.createbucket(input) iferr==nil{ fmt.printf("create bucket:%s successful!\n",input.bucket) fmt.printf("requestid:%s\n",output.requestid) return } fmt.printf("create bucket:%s fail!\n",input.bucket) ifobserror,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) } } |
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨