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

request

createbucketrequest

是

参数解释：

创建桶请求参数，详见createbucketrequest。

bucketname

string

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

location

string

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

参数解释：

桶所在的区域。

约束限制：

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

取值范围：

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

默认取值：

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

acl

accesscontrollist

可选

参数解释：

创桶时可指定桶的acl访问策略，您可以使用预定义的acl策略，也可以自定义acl策略，有关访问控制列表（access control list，acl）功能的详细信息可参见acl功能介绍。

取值范围：

• 如果使用预定义acl策略，则可选策略参见acl预定义访问策略。
• 如果选择自定义acl策略，则可以根据accesscontrollist参数描述，自行给参数赋值。

默认取值：

accesscontrollist.rest_canned_private

storageclass

storageclassenum

可选

参数解释：

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

取值范围：

可选择的访问策略选项参见storageclassenum。

默认取值：

standard，即标准存储类别。

extensionpermissionmap

map<extensionbucketpermissionenum, set>

可选

参数解释：

桶acl的授权map，您可以为一个或多个账号授予桶权限。map的extensionbucketpermissionenum用于指定权限，map的set用于说明该权限授予的账号id列表，即domain_id列表。

取值范围：

• 授予权限的范围详见extensionbucketpermissionenum。
• 如何获取账号id请参见

默认取值：

无

epid

string

可选

参数解释：

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

约束限制：

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

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

默认取值：

无

availablezone

availablezoneenum

可选

参数解释：

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

约束限制：

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

取值范围：

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

默认取值：

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

buckettype

buckettypeenum

可选

参数解释：

创建的桶类型。

取值范围：

详见buckettypeenum。

默认取值：

object，即对象桶。

accesscontrollist.rest_canned_private

私有读写。

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

accesscontrollist.rest_canned_public_read

公共读。

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

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

accesscontrollist.rest_canned_public_read_write

公共读写。

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

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

accesscontrollist.rest_canned_public_read_delivered

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

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

不能应用于对象。

accesscontrollist.rest_canned_public_read_write_delivered

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

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

不能应用于对象。

grant_read

授予对应账号id的账号read权限。

账号被授予read权限后，针对当前正在创建的桶，允许列举桶内对象、列举桶中多段任务、列举桶中多版本对象、获取桶元数据。

grant_write

授予对应账号id的账号read权限。

账号被授予write权限后，针对当前正在创建的桶，允许创建、删除、覆盖桶内所有对象，允许初始化段、上传段、拷贝段、合并段、取消多段上传任务。

grant_read_acp

授予对应账号id的账号read_acp权限。

账号被授予read_acp权限后，针对当前正在创建的桶，允许读桶的acl信息。

grant_write_acp

授予对应账号id的账号write_acp权限。

账号被授予write_acp权限后，针对当前正在创建的桶，允许修改桶的acl信息。

grant_full_control

授予对应账号id的账号full_control权限。

账号被授予full_control权限后，针对当前正在创建的桶，允许进行任何操作。

grant_read_delivered

授予对应账号id的账号read权限，并且在默认情况下，该read权限将传递给桶内所有对象。

grant_full_control_delivered

授予对应账号id的账号full_control权限，并且在默认情况下，该full_control权限将传递给桶内所有对象。

owner

owner

可选

参数解释：

桶所有者的信息，详见owner。

delivered

boolean

可选

参数解释：

桶的acl是否向桶内对象传递，作用于桶内所有对象。

取值范围：

true：是，桶acl向桶内对象传递。

false：否，桶acl不向桶内对象传递，仅作用于桶。

默认取值：

false

grants

set<grantandpermission>

可选

参数解释：

被授权用户相关信息，详见grantandpermission。

id

string

必选

参数解释：

桶所有者的账号id，即domain_id。

取值范围：

如何获取账号id请参见。

默认取值：

无

displayname

string

可选

参数解释：

所有者的账号名。

取值范围：

如何获取账号名请参见。

默认取值：

无

grantee

granteeinterface

必选

参数解释：

被授权用户或用户组，详见granteeinterface。

permission

permission

必选

参数解释：

用户或用户组被授予的权限。

取值范围：

详见permission。

默认取值：

无

delivered

boolean

可选

参数解释：

桶的acl是否向桶内对象传递，作用于桶内所有对象。

取值范围：

true：是，桶acl向桶内对象传递。

false：否，桶acl不向桶内对象传递，仅作用于桶。

默认取值：

false

canonicalgrantee

canonicalgrantee

必选

参数解释：

被授权用户的用户信息，详见canonicalgrantee。

groupgrantee

groupgrantee

必选

参数解释：

被授权用户组的用户组信息。

取值范围：

详见groupgrantee。

默认取值：

无

grantid

string

如果type为用户类型则必选

参数解释：

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

取值范围：

如何获取账号id请参见。

默认取值：

无

displayname

string

可选

参数描述：

被授权用户的账号名。

取值范围：

如何获取账号名请参见。

默认取值：

无

all_users

所有用户。

authenticated_users

授权用户，已废弃。

log_delivery

日志投递组，已废弃。

permission_read

read

读权限。

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

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

permission_write

write

写权限。

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

此权限在对象上不适用。

permission_read_acp

read_acp

读取acl配置的权限。

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

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

permission_write_acp

write_acp

修改acl配置的权限。

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

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

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

permission_full_control

full_control

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

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

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

standard

standard

标准存储。

warm

warm

低频访问存储。

cold

cold

归档存储。

deep_archive

deep_archive

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

multi_az

3az

多az类型

object

object

对象桶

pfs

posix

并行文件系统

statuscode

int

参数解释：

http状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。

完整的状态码列表请参见。

默认取值：

无

responseheaders

map

参数解释：

响应消息头列表，由多个元组构成。元组中string代表响应头的名称，object代表响应头的值。

默认取值：

无

bucketname

string

参数解释：

桶名。

约束限制：

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

默认取值：

无

owner

owner

参数解释：

桶拥有者信息，详见owner。

creationdate

java.util.date

参数解释：

桶创建时间。

默认取值：

无

location

string

参数解释：

桶所在的区域。

约束限制：

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

取值范围：

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

默认取值：

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

storageclass

storageclassenum

参数解释：

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

取值范围：

可选择的访问策略选项参见storageclassenum。

默认取值：

standard，即标准存储类别。

acl

accesscontrollist

参数解释：

创桶时可指定桶的acl访问策略，您可以使用预定义的acl策略，也可以自定义acl策略，有关访问控制列表（access control list，acl）功能的详细信息可参见acl功能介绍。

取值范围：

• 如果使用预定义acl策略，则可选策略参见acl预定义访问策略。
• 如果选择自定义acl策略，则可以根据accesscontrollist参数描述，自行给参数赋值。

默认取值：

accesscontrollist.rest_canned_private

buckettypeenum

buckettypeenum

参数解释：

创建的桶类型。

取值范围：

详见buckettypeenum。

默认取值：

object，即对象桶。