CreateDBInstance--表格数据库 HBase 版-火山引擎

文档中心

立即注册

导航

CreateDBInstance

最近更新时间：2024.09.12 17:23:05首次发布时间：2022.11.23 11:57:58

调用 CreateDBInstance 接口创建 HBase 实例。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceName	String	否	test_api	实例名称。名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在 1~128 个字符内。说明若该参数留空，实例 ID 会默认作为实例名称。
InstanceType	String	否	Standard	实例类型。当前仅支持标准型，取值默认为 `Standard`。
EngineVersion	String	是	HBase_2.0	HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本，取值默认为 `HBase_2.0`。
MultiAZ	Bool	否	false	实例的部署方式，取值： `true`：多可用区部署。 `false`：单可用区部署（默认）。说明关于可用区部署方案的更多详情，请参见多可用区同城容灾解决方案
ZoneId	String	是	cn-beijing-a	可用区 ID。当 `MultiAZ`（部署方式）取值为 `false`（单可用区部署）时，则只需输入一个可用区 ID。当 `MultiAZ`（部署方式）取值为 `true`（多可用区部署）时，则需要输入两个不同的可用区 ID，第一个为主可用区 ID，第二个为备可用区 ID，多个可用区 ID 之间使用英文逗号（,）分隔。说明您可以调用 DescribeZones 接口查询 HBase 实例指定地域下所有可用区的资源信息，包括可用区 ID。
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询 HBase 实例所有可用的地域资源信息，包括地域 ID。
MasterSpec	String	是	hbase.x1.medium	Master 节点的规格码。说明关于 Master 节点所支持的规格信息，请参见实例规格。 Master 节点数量为固定值，且不支持增减。
RSCount	Integer	是	4	RegionServer 节点数量。当 `MultiAZ`（部署方式）取值为 `false`（单可用区部署）时，取值范围为 2~100 之间的整数。当 `MultiAZ`（部署方式）取值为 `true`（多可用区部署）时，取值范围为 4~100 之间的偶数整数，节点数量平均分配至主/备可用区。
RSSpec	String	是	hbase.x1.large	RegionServer 节点的规格码。说明关于 RegionServer 节点所支持的规格信息，请参见实例规格。
StorageType	String	否	HdfsHdd	实例的存储类型，取值： `HdfsHdd`：HDD 文件存储（默认）。 `HdfsSsd`：SSD 文件存储。
StorageCapacity	Integer	是	1000	存储空间大小，步长为 10GiB。当 `MultiAZ`（部署方式）取值为 `false`（单可用区部署）时，取值范围为 100~20,000。当 `MultiAZ`（部署方式）取值为 `true`（多可用区部署）时，取值范围为 200~20,000。说明多可用区采用主副本架构，实际可用容量为总容量的一半。
EnableCloudStorage	Bool	否	true	是否开通存储型容量，取值： `true`：开通容量型存储。 `false`：不开通容量型存储（默认）。说明容量型存储的详细介绍，请参见冷热分离介绍。仅当 `MultiAZ`（部署方式）取值为 `false`（单可用区部署）时，支持冷热分离功能。
ColdStorage	Integer	否	800	设置容量型存储空间大小，取值范围：800GiB~1,000,000GiB，步长为 10GiB。说明当 `EnableCloudStorage` 取值为 `true` 时，该参数必填。
VpcId	String	是	vpc-2d66uvmd9i8lc58ozz****	私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息，包括私有网络 ID。
SubnetId	String	是	subnet-2d6pl8bcpl2io58ozfd43****	子网 ID。子网必须属于所选的可用区。当 `MultiAZ`（部署方式）取值为 `false`（单可用区部署）时，只需输入一个子网 ID。当 `MultiAZ`（部署方式）取值为 `true`（多可用区部署）时，则需要输入两个不同的子网 ID。第一个为主可用区的子网 ID，第二个为备可用区的子网 ID，多个子网 ID 之间使用英文逗号（,）分隔。说明子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址，您可以调用 CreateSubnet 接口创建子网。您可以调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID。
ProjectName	String	否	default	选择实例所属的项目。若该参数留空，新建的实例默认加入 `default` 项目。说明项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色对这些资源的权限。更多详情，请参见资源管理。
EnableAuth	Bool	否	false	是否开启登录认证。取值： `true`：开启登录认证。实例创建成功后，您需要立即为实例创建数据库账号，详情请参见 CreateDBAccount。 `false`：不开启登录认证（默认）。说明仅当 `MultiAZ`（部署方式）取值为 `false`（单可用区部署）时，支持开启登录认证。开启登录认证后，仅对 Java 客户端生效，Thrift 连接依旧采用直连方式。
ChargeType	String	是	PostPaid	计费类型，取值： `PostPaid`：按量计费（后付费）。 `PrePaid`：包年包月（预付费）。
PurchaseMonths	Integer	否	1	购买时长，单位：月。取值范围：`1`，`2`，`3`，`4`，`5`，`6`，`7`，`8`，`9`，`12`，`24`，`36`。说明当 `ChargeType` 为 `PrePaid` 时，该参数必填。
AutoRenew	Bool	否	false	预付费场景下是否自动续费。取值： `true`：自动续费。 `false`：不自动续费（默认）。说明仅当 `ChargeType` 为 PrePaid 时有效。
DeletionProtection	String	否	enabled	实例删除保护功能开关状态。取值范围： `enabled`：已开启。 `disabled`：未开启（默认）。说明关于实例删除保护的更多信息，请参见实例删除保护。
Tags	Object[]	否		需要绑定的标签键和标签值数组对象。说明支持一次传入多组标签键值对像，多组标签键值对像间用英文逗号（,）分隔。单次最多同时传入 20 组标签键值对，单个实例最多绑定 50 个标签。标签键值需满足设置规则，具体规则请参见标签设置规则。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

参数	类型	示例值	描述
InstanceId	String	hb-cn01762cf4d6****	实例 ID。
OrderNo	String	Order730602621667020****	订单 ID。

请求示例

创建单可用区实例

POST https://hbase.volcengineapi.com/?Action=CreateDBInstance&Version=2018-01-01 HTTP/1.1
Host: hbase.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/hbase/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "RegionId":"cn-beijing",
    "ZoneId":"cn-beijing-a",
    "InstanceName":"test_api",
    "MasterSpec":"hbase.x1.medium",
    "RSCount":3,
    "RSSpec":"hbase.x1.large",
    "StorageCapacity":600,
    "ChargeType": "PostPaid",
    "EngineVersion": "HBase_2.0",
    "VpcId":"vpc-3redy6326y7ls5zsk2iko****",
    "SubnetId":"subnet-3redy6qqkavb45zsk2i1m****",
    "StorageType":"HdfsSsd",
    "Tags":[
        {
            "Key":"chargetype",
            "Value":"postpaid"
        }
    ]
}

创建多可用区实例

POST https://hbase.volcengineapi.com/?Action=CreateDBInstance&Version=2018-01-01 HTTP/1.1
Host: hbase.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/hbase/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "RegionId":"cn-beijing",
    "ZoneId":"cn-beijing-a,cn-beijing-b",
    "InstanceName":"test_api",
    "MasterSpec":"hbase.x1.medium",
    "MultiAZ": true,
    "RSCount":4,
    "RSSpec":"hbase.x1.large",
    "StorageCapacity":600,
    "ChargeType": "PostPaid",
    "EngineVersion": "HBase_2.0",
    "VpcId":"vpc-3jh4ev6l5n01s3pncmfj5****",
    "SubnetId":"subnet-3jhhy08zsuakg3pncmfwx****,subnet-2gd0b9x8hfeo050ztz08a****",
    "StorageType":"HdfsHdd",
    "Tags":[
        {
            "Key":"chargetype",
            "Value":"postpaid"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202303141924047CADEE887F9E5297****",
        "Action": "CreateDBInstance",
        "Version": "2018-01-01",
        "Service": "hbase",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "hb-cn01762cf4d6****",
        "OrderNo": "Order721036083523859****"
    }
}