文档首页/ 对象存储服务 OBS/ SDK参考/ Harmony（公测）/ 桶相关接口(Harmony SDK)/ 创建桶(Harmony SDK)
更新时间：2024-12-02 GMT+08:00
查看PDF
分享

创建桶(Harmony SDK)

功能介绍

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

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

接口约束

  • 您必须拥有obs:bucket:CreateBucket权限，才能创建桶。建议使用IAM进行授权，配置方式详见使用IAM自定义策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

    创建桶时，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），则可以不指定区域；如果使用的终端节点归属于其他区域，则必须指定区域，且指定的区域必须与终端节点归属的区域一致。当前有效的区域名称可从这里查询。比如初始化时使用的终端节点EndPoint是obs.cn-north-4. myhuaweicloud.com，那么在创建桶的时候必须指定Location：cn-north-4 才会创建成功，否则会返回状态码400。

  • 同一账号下，可以创建多个存桶，数量上限是100个（不区分地域），存储桶中的对象数量和大小没有限制。
  • 新创建桶的桶名在OBS中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回HTTP状态码200。除此以外的其他场景重复创建同名桶返回HTTP状态码409，表明桶已存在。
  • 用户删除桶后，需要等待30分钟才能创建同名桶和并行文件系统。
  • 并不是所有区域都支持创建多AZ桶，您可以在产品价格详情页面，查询指定区域是否支持多AZ。

方法定义

createBucket(input: CreateBucketInput): Response<CreateBucketOutput>

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

CreateBucketInput

必选

参数解释：

创建桶接口入参，详见CreateBucketInput。
表2 CreateBucketInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释：

桶名。

约束限制：

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

取值范围：

长度为3～63个字符。

默认取值：

无

Location

string

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

参数解释：

桶所在的区域。

约束限制：

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

取值范围：

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

默认取值：

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

ACL

AclType

可选

参数解释：

创桶时可指定的预定义访问策略，有关访问控制列表（Access Control List，ACL）功能的详细信息可参见ACL功能介绍。

约束限制：

无

取值范围：

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

默认取值：

无

StorageClass

StorageClassType

可选

参数解释：

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

约束限制：

无

取值范围：

桶的存储类型参见StorageClassType。

默认取值：

无

GrantRead

string

可选

参数解释：

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

约束限制：

无

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK)

默认取值：

无

GrantWrite

string

可选

参数解释：

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

约束限制：

无

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK)

默认取值：

无

GrantReadACP

string

可选

参数解释：

被授予READ_ACP权限的账号的账号ID，即domain_id。账号被授予READ_ACP权限后，针对当前正在创建的桶，允许读桶的ACL信息。

约束限制：

无

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK)

默认取值：

无

GrantWriteACP

string

可选

参数解释：

被授予WRITE_ACP权限的账号的账号ID，即domain_id。账号被授予WRITE_ACP权限后，针对当前正在创建的桶，允许修改桶的ACL信息。

约束限制：

无

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK)

默认取值：

无

GrantFullControl

string

可选

参数解释：

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

约束限制：

无

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK)

默认取值：

无

GrantReadDelivered

string

可选

参数解释：

被授予READ权限的账号的账号ID，即domain_id。授权指定账号有READ权限，并且在默认情况下，该READ权限将传递给桶内所有对象。

约束限制：

无

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK)

默认取值：

无

GrantFullControlDelivered

string

可选

参数解释：

被授予FULL_CONTROL权限的账号的账号ID，即domain_id。授权指定账号有当前桶的全部控制权限，并且在默认情况下，该FULL_CONTROL权限将传递给桶内所有对象。

约束限制：

无

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK)

默认取值：

无

Epid

string

可选

参数解释：

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

约束限制：

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

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

默认取值：

无

AzRedundancy

string

可选

参数解释：

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

约束限制：

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

取值范围：

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

默认取值：

无

FileInterface

string

可选

参数解释：

是否创建并行文件系统。

约束限制：

无

取值范围：

可选值为Enabled

默认取值：

无，不设置则创建对象桶。
表3 AclType

常量名

原始值

说明

PRIVATE

private

私有读写。

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

PUBLIC_READ

public-read

公共读私有写。

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

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

PUBLIC_READ_WRITE

public-read-write

公共读写。

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

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

PUBLIC_READ_DELIVERED

public-read-delivered

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

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

说明：

AclPublicReadDelivered不能应用于对象。

PUBLIC_READ_WRITE_DELIVERED

public-read-write-delivered

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

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

说明：

AclPublicReadWriteDelivered不能应用于对象。

BUCKET_OWNER_FULL_CONTROL

bucket-owner-full-control

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

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

常量名

原始值

说明

STANDARD

STANDARD

标准存储。

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

WARM

WARM

低频访问存储。

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

COLD

COLD

归档存储。

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

DEEP_ARCHIVE

DEEP_ARCHIVE

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

适用于长期不访问（平均几年访问一次）数据的业务场景。

返回结果说明

表5 返回结果

参数类型

描述

Response

说明：

该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。

参数解释：

接口返回信息，详见Response。
表6 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释：

接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。

InterfaceResult

BaseResponseOutput

参数解释：

操作成功后的结果数据，详见BaseResponseOutput。

约束限制：

当Status大于300时为空。
表7 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释：

OBS服务端返回的HTTP状态码。

取值范围：

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

Code

string

参数解释：

OBS服务端返回的错误码。

Message

string

参数解释：

OBS服务端返回的错误描述。

HostId

string

参数解释：

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释：

OBS服务端返回的请求ID。

Id2

string

参数解释：

OBS服务端返回的请求ID2。

Indicator

string

参数解释：

OBS服务端返回的详细错误码。
表8 BaseResponseOutput

参数名称

参数类型

描述

RequestId

string

参数解释：

OBS服务端返回的请求ID。

代码示例

本示例用于创建名为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
 
// 引入依赖包
import ObsClient, { AclType, StorageClassType, CreateBucketInput } from '@obs/esdk-obs-harmony';

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: process.env.ACCESS_KEY_ID,
  SecretAccessKey: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入
  // SecurityToken: process.env.SECURITY_TOKEN,
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function createBucket() {
  try {
    const params: CreateBucketInput = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定存储桶所在区域，此处以“cn-north-4”为例，必须跟传入的Endpoint中Region保持一致
      Location: "cn-north-4",
      // 指定存储桶的权限控制策略，此处以AclType.PRIVATE为例
      ACL: AclType.PRIVATE,
      // 指定存储桶的存储类型，此处以StorageClassType.WARM为例。如果未指定该参数，则创建的桶为低频访问存储
      StorageClass: StorageClassType.WARM,
      // 指定存储桶的AZ类型，此处以“3az”为例。不携带时默认为单AZ，如果对应region不支持多AZ存储，则该桶的存储类型仍为单AZ
      AzRedundancy: "3az",
    };
    // 创建桶
    const result = await obsClient.createBucket(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Create bucket(%s) successful!", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      return;
    }
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("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.");
    console.log(error);
  }
}

createBucket();

相关链接

  • 关于创建桶的API说明，请参见创建桶。
  • 创建桶过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
  • 创建桶常见问题请参见创建桶失败。

相关文档