You need to enable JavaScript to run this app.
导航
表格数据库 HBase 版
  • 文档首页
    • /
  • 表格数据库 HBase 版

CreateDBInstance

最近更新时间：2024.03.11 15:49:42

首次发布时间：2022.11.23 11:57:58

我的收藏

调用 CreateDBInstance 接口创建 HBase 实例。

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述

RegionId

String

是

cn-beijing

地域 ID。

说明

您可以调用 DescribeRegions 接口查询 HBase 实例所有可用的地域资源信息，包括地域 ID。

ZoneId

String

是

cn-beijing-a

可用区 ID。

说明

您可以调用 DescribeZones 接口查询 HBase 实例指定地域下所有可用区的资源信息，包括可用区 ID。

MasterSpec

String

是

hbase.x1.medium

Master 节点的规格码。

说明

  • 关于 Master 节点所支持的规格信息，请参见实例规格。
  • Master 节点数量固定为 2，不支持增减。
RSCountInteger是4RegionServer 节点数量。 取值范围：2~100。

RSSpec

String

是

hbase.x1.large

RegionServer 节点的规格码。

说明

关于 RegionServer 节点所支持的规格信息，请参见实例规格。

StorageType

String

是

HdfsHdd

实例的存储类型，取值：

  • HdfsHdd：HDD 文件存储。
  • HdfsSsd：SSD 文件存储。
StorageCapacityInteger是1000存储空间，取值范围：100~20,000，单位：GiB。步长为 10GiB。

EnableCloudStorage

Bool

否

true

是否开通存储型容量，取值：

  • true：开通容量型存储。
  • false：不开通容量型存储。

说明

容量型存储的详细介绍，请参见冷热分离介绍。

ColdStorage

Integer

否

800

设置容量型存储空间大小，取值范围：800GiB~1,000,000GiB，步长为 10GiB。

说明

当 EnableCloudStorage 取值为 true 时，该参数必填。

ChargeType

String

是

PostPaid

实例计费类型。取值：

  • PostPaid：按量计费。
  • PrePaid：包年包月。
EngineVersionString是HBase_2.0HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本，取值默认为 HBase_2.0。

VpcId

String

是

vpc-2d66uvmd9i8lc58ozz****

私有网络 ID。

说明

您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息，包括私有网络 ID。

SubnetId

String

是

subnet-1g15j13jtzgu88ibuxwqp****

子网 ID。子网必须属于所选的可用区。

说明

  • 子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址，您可以调用 CreateSubnet 接口创建子网。
  • 您可以调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID。

InstanceName

String

否

test_api

实例名称。名称需同时满足如下要求：

  • 不能以数字、中划线（-）开头。
  • 只能包含中文、字母、数字、下划线（_）和中划线（-）。
  • 长度需要在 1~128 个字符内。

说明

若该参数留空，实例 ID 会默认作为实例名称。

InstanceTypeString否Standard实例类型。当前仅支持标准型，取值默认为 Standard。

ProjectName

String

否

default

选择实例所属的项目。若该参数留空，新建实例不会加入任何项目。

说明

项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色对这些资源的权限。更多详情，请参见资源管理。

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

Array of TagObject

否

请参见请求示例。

需要绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见数据结构。

说明

  • 支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。单次最多同时传入 20 组标签键值对，单个实例最多绑定 50 个标签。
  • 标签键值需满足设置规则，具体规则请参见标签设置规则。
ClientTokenString否WbiAlPqJM6tMoSOYhT****用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回数据

名称类型示例值描述
InstanceIdStringhb-cn01762cf4d6****实例 ID。
OrderNoStringOrder721036083523859****订单编号。

请求示例

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"
        }
    ]
}

返回示例

正常返回示例

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