# 创建桶(Node.js SDK) ![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/notice_3.0-zh-cn.png) 开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-nodejs-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。 #### 功能介绍 OBS桶是对象的容器，您上传的文件都将以对象的形式存放在桶中。本文介绍如何使用Node.js SDK创建桶。 调用创建桶接口，将在当前账号按照用户指定的桶名创建一个新桶，接口支持根据用户诉求，在创建桶的同时配置桶的存储类别、区域及桶ACL等参数。 #### 接口约束 - 您必须拥有obs:bucket:CreateBucket权限，才能创建桶。建议使用IAM进行授权，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。创建桶时，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），则可以不指定区域；如果使用的终端节点归属于其他区域，则必须指定区域，且指定的区域必须与终端节点归属的区域一致。当前有效的区域名称可从[这里](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)查询。比如初始化时使用的终端节点EndPoint是obs.cn-north-4.myhuaweicloud.com，那么在创建桶的时候必须指定Location：cn-north-4才会创建成功，否则会返回状态码400。 - 同一账号下，可以创建多个存储桶，数量上限是100个（不区分地域），存储桶中的对象数量和大小没有限制。 - 新创建桶的桶名在OBS中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回HTTP状态码200。除此以外的其他场景重复创建同名桶返回HTTP状态码409，表明桶已存在。 - 用户删除桶后，需要等待30分钟才能创建同名桶和并行文件系统。 - 并不是所有区域都支持创建多AZ桶，您可以在[产品价格详情](https://www.huaweicloud.com/pricing.html?tab=detail#/obs)页面，查询指定区域是否支持多AZ。 #### 方法定义 ``` ObsClient.createBucket(params) ``` #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 长度为3～63个字符。 **默认取值：** 无 | | Location | string | 如果请求的OBS服务地址所在区域为默认区域，则可为空，否则为必选。 | **参数解释** **：** 桶所在的区域。 **约束限制：** 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 **取值范围：** 当前有效的OBS区域和终端节点的更多信息，请参考[地区和终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 **默认取值：** 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。 | | ACL | [AclType] | 可选 | **参数解释** **：** 创桶时可指定的预定义ACL，有关访问控制列表（Access Control List，ACL）功能的详细信息可参见[ACL功能介绍](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0005.html)。 **约束限制：** 无 **取值范围：** 可选择的ACL选项参见[AclType]。 **默认取值：** private，即私有 | | StorageClass | [StorageClassType] | 可选 | **参数解释** **：** 创桶时可指定的桶的存储类别。 **约束限制：** 无 **取值范围：** 桶的存储类别参见[StorageClassType]。 **默认取值：** STANDARD，即标准存储类别 | | GrantRead | string | 可选 | **参数解释** **：** 被授予READ权限的账号的账号ID，即domain_id。账号被授予READ权限后，针对当前正在创建的桶，允许列举桶内对象、列举桶中多段任务、列举桶中多版本对象、获取桶元数据。 **约束限制：** 无 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantWrite | string | 可选 | **参数解释** **：** 被授予WRITE权限的账号的账号ID，即domain_id。账号被授予WRITE权限后，针对当前正在创建的桶，允许创建、删除、覆盖桶内所有对象，允许初始化段、上传段、复制段、合并段、取消多段上传任务。 **约束限制：** 无 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantReadACP | string | 可选 | **参数解释** **：** 被授予READ_ACP权限的账号的账号ID，即domain_id。账号被授予READ_ACP权限后，针对当前正在创建的桶，允许读桶的ACL信息。 **约束限制：** 无 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantWriteACP | string | 可选 | **参数解释** **：** 被授予WRITE_ACP权限的账号的账号ID，即domain_id。账号被授予WRITE_ACP权限后，针对当前正在创建的桶，允许修改桶的ACL信息。 **约束限制：** 无 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantFullControl | string | 可选 | **参数解释** **：** 被授予FULL_CONTROL权限的账号的账号ID，即domain_id。账号被授予FULL_CONTROL权限后，针对当前正在创建的桶，允许进行任何操作。 **约束限制：** 无 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantReadDelivered | string | 可选 | **参数解释** **：** 被授予READ权限的账号的账号ID，即domain_id。授权指定账号有READ权限，并且在默认情况下，该READ权限将传递给桶内所有对象。 **约束限制：** 无 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantFullControlDelivered | string | 可选 | **参数解释** **：** 被授予FULL_CONTROL权限的账号的账号ID，即domain_id。授权指定账号有当前桶的全部控制权限，并且在默认情况下，该FULL_CONTROL权限将传递给桶内所有对象。 **约束限制：** 无 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | MultiEnterprise | string | 可选 | **参数解释** **：** 创桶时可指定的企业项目ID，开通企业项目的用户可以从企业项目服务获取。 **约束限制：** Epid格式为uuid，未开通企业项目的用户可以不带该头域。 示例：9892d768-2d13-450f-aac7-ed0e44c2585f **默认取值：** 无 | | AzRedundancy | string | 可选 | **参数解释** **：** 创桶时可指定的数据冗余类型，即AZ类型。 **约束限制：** 归档和深度归档存储不支持多AZ。如果桶所在区域不支持多AZ存储，则该桶的存储类别默认为单AZ。 **取值范围：** - 如果将桶配置为多AZ，则取值为3az。 - 如果将桶配置为单AZ，则无需选择此选项，系统默认赋值。 **默认取值：** 单AZ | | FileInterface | string | 可选 | **参数解释** **：** 是否创建并行文件系统。 **约束限制：** 无 **取值范围：** 可选值为Enabled **默认取值：** 无，不设置则创建对象桶。 | 表2AclType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.AclPrivate | private | 私有读写。 桶或对象的所有者拥有完全控制的权限，其他任何人都没有访问权限。 | | ObsClient.enums.AclPublicRead | public-read | 公共读私有写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上，所有人可以获取该对象内容和元数据。 | | ObsClient.enums.AclPublicReadWrite | public-read-write | 公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务。 设在对象上，所有人可以获取该对象内容和元数据。 | | ObsClient.enums.AclPublicReadDelivered | public-read-delivered | 桶公共读，桶内对象公共读。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadDelivered不能应用于对象。 | | ObsClient.enums.AclPublicReadWriteDelivered | public-read-write-delivered | 桶公共读写，桶内对象公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadWriteDelivered不能应用于对象。 | | ObsClient.enums.AclBucketOwnerFullControl | bucket-owner-full-control | 设在对象上，桶和对象的所有者拥有对象的完全控制权限，其他任何人都没有访问权限。 默认情况下，上传对象至其他用户的桶中，桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后，桶所有者可以完全控制对象。例如，用户A上传对象x至用户B的桶中，系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后，用户B就拥有了对象x的控制权。 | 表3StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.StorageClassStandard | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | ObsClient.enums.StorageClassWarm | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | ObsClient.enums.StorageClassCold | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | 无 | DEEP_ARCHIVE | 深度归档存储 适用于长期不访问（平均几年访问一次）数据的业务场景 | #### 返回结果说明 表4返回结果 | **参数类型** | 描述 | |:---|:---| | [表5] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表5]。 | 表5Response | **参数名称** | **参数类型** | 描述 | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [BaseResponseOuput] | **参数解释：** 操作成功后的结果数据，详见[BaseResponseOuput]。 **约束限制** **：** 当Status大于300时为空。 | 表6ICommonMsg | **参数名称** | **参数类型** | **描述** | |---|---|---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表7BaseResponseOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | #### 代码示例 本示例用于创建名为examplebucket的桶，并设置所在区域在华北-北京四（cn-north-4），桶ACL是私有，存储类型是低频访问存储，多AZ方式存储。 ``` // 引入obs库 // 使用npm安装 const ObsClient = require("esdk-obs-nodejs"); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入 // security_token: process.env.SECURITY_TOKEN, // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function createBucket() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", // 指定存储桶所在区域，此处以“cn-north-4”为例，必须跟传入的Endpoint中Region保持一致 Location: "cn-north-4", // 指定存储桶ACL，此处以私有读写obs.AclPrivate为例 ACL: obsClient.enums.AclPrivate, // 指定存储桶的存储类型，此处以低频访问存储obs.StorageClassWarm为例。如果未指定该参数，则创建的桶为标准存储 StorageClass: obsClient.enums.StorageClassWarm, // 指定存储桶的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(); ```