文档

CreateCluster

更新时间:

调用CreateCluster接口创建云数据库HBase实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数。取值:CreateCluster

RegionId String cn-hangzhou

实例所属的地域ID,可调用DescribeRegions接口获取。

ZoneId String cn-hangzhou-f

可用区ID,可调用DescribeRegions接口获取。

ClusterName String hbase_test

实例名称。命名规则为:

  • 长度为2~128个字符。
  • 以大小写字母或中文开头。
  • 可包含数字或者特殊字符,特殊字符包括半角句号(.)、短横线(-)和下划线(_)。
VpcId String vpc-bp120k6ixs4eog****

专有网络ID。

说明 本参数与VswitchId参数同时为空时表示实例的网络类型为经典网络。
VSwitchId String vsw-bp191otqj1ssyl****

专有网络下的虚拟交换机ID。

MasterInstanceType String hbase.sn1.medium

Master节点规格,可调用DescribeAvailableResource接口获取规格值。

CoreInstanceType String hbase.sn1.medium

Core节点规格,可调用DescribeAvailableResource接口获取规格值。

DiskType String cloud_ssd

实例的Core磁盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • local_hdd_pro:本地HDD盘。
  • local_ssd_pro:本地SSD盘。
  • cloud_essd_pl1:ESSD云盘。
DiskSize Integer 400

Core单节点磁盘大小,单位:GB。

  • 如果实例为单节点,Core单节点磁盘容量的范围为20~500 GB,步长为1 GB。
  • 如果实例为云盘版,Core单节点磁盘容量的范围为400~64000 GB,步长为40 GB。
  • 如果实例为本地盘,Core单节点磁盘容量与Core节点规格有关,具体如下:

    • Core节点规格为hbase.d1.4xlarge时,磁盘容量为44000。
    • Core节点规格为hbase.d1.6xlarge时,磁盘容量为66000。
    • Core节点规格为hbase.d1.8xlarge时,磁盘容量为88000。
    • Core节点规格为hbase.i2.xlarge时,磁盘容量为894。
    • Core节点规格为hbase.i2.2xlarge时,磁盘容量为1788。
    • Core节点规格为hbase.i2.4xlarge时,磁盘容量为3576。
    • Core节点规格为hbase.i2.8xlarge时,磁盘容量为7152。
    • Core节点规格为hbase.d2s.5xlarge时,磁盘容量为58400。
    • Core节点规格为hbase.d2s.10xlarge时,磁盘容量为109500。
NodeCount Integer 2

Core节点个数,取值如下:

  • 如果实例为单节点,Core节点个数固定为1个。
  • 如果实例为云盘版,Core节点个数取值范围为2~100
  • 如果实例为本地盘,Core节点个数取值范围为4~100
PayType String Prepaid

实例的付费类型,取值:

  • Prepaid:包年包月(预付费)。
  • Postpaid:按量付费(后付费)。
Engine String hbase

数据库引擎类型:

  • hbase:HBase标准版或HBase单机版。
  • hbaseue:HBase增强版。
  • bds:表示BDS实例。
SecurityIPList String 116.62.XX.XX/24

添加实例的白名单IP地址,多个白名单IP地址之间使用半角逗号(,)分隔。

说明 如果IP地址设置为127.0.0.1,表示禁止所有地址访问该实例。例如IP地址为192.168.0.0/24表示允许所有192.168.0.XX的IP地址访问该实例。
EngineVersion String 2.0

实例的引擎版本,与引擎类型有关,取值:

  • 如果实例的引擎类型为hbase,引擎版本为1.1或者2.0
  • 如果实例的引擎类型为hbaseue,引擎版本为2.0
  • 如果实例的引擎类型为bds,引擎版本为1.0
ColdStorageSize Integer 1024

实例的冷存储容量大小,单位为GB。取值如下:

  • 取值为0:表示不开启冷存储。
  • 取值范围为800~1000000:表示开启冷存储。
说明 仅当实例的引擎类型为hbaseue时,开启冷存储功能才有效。
PeriodUnit String month

包年包月实例的购买单位,取值:

  • year:年。
  • month:月。
说明 仅当实例的付费类型为Prepaid时,需要填写此参数。
Period Integer 6

包年包月实例的购买时长,取值:

  • 当PeriodUnit为year时,取值范围为1~3
  • 当PeriodUnit为month时,取值范围为1~9
说明 仅当实例的付费类型为Prepaid时,需要填写此参数。
AutoRenewPeriod Integer 2

设置实例自动续费周期,单位为月。

说明
  • 自动续费周期默认值为0,表示实例到期后不自动续费。
  • 例如自动续费周期设置为2,表示实例到期后自动续费2个月。
ClientToken String ETnLKlblzczshOTUbOCz****

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ResourceGroupId String rg-j4d53glb3****

资源组ID。资源组详情请参见查看资源组基本信息

EncryptionKey String 0d2470df-da7b-4786-b981-9a164dae****

加密的密钥ID,如果未启用加密则为空。

说明 当前云盘版加密开启后无法关闭。

返回数据

名称 类型 示例值 描述
RequestId String 3E19E345-101D-4014-946C-A205

请求ID。

OrderId String 23232069786****

订单ID。

ClusterId String hb-bp1hy2sjf8gd****

实例ID。

示例

请求示例

http(s)://hbase.aliyuncs.com/?Action=CreateCluster
&ClusterName=hbase_test
&CoreInstanceType=hbase.sn1.medium
&DiskSize=400
&DiskType=cloud_ssd
&Engine=hbase
&EngineVersion=2.0
&MasterInstanceType=hbase.sn1.medium
&NodeCount=2
&PayType=Prepaid
&RegionId=cn-hangzhou
&SecurityIPList=116.62.XX.XX/24
&VpcId=vpc-bp120k6ixs4eog*****
&VSwitchId=vsw-bp191ipotqj1ssyl*****
&ZoneId=cn-hangzhou-f
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateClusterResponse>
    <RequestId>3E19E345-101D-4014-946C-A205</RequestId>
    <OrderId>23232069786****</OrderId>
    <ClusterId>hb-bp1hy2sjf8gd****</ClusterId>
</CreateClusterResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3E19E345-101D-4014-946C-A205",
  "OrderId" : "23232069786****",
  "ClusterId" : "hb-bp1hy2sjf8gd****"
}

错误码

访问错误中心查看更多错误码。