New interface to create an HBase cluster


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Prameter Type Required Example Description
Action String Yes CreateCluster

Required. Set the value to CreateCluster.

ClusterName String Yes hbase_test

Cluster Name

The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

CoreInstanceType String Yes hbase.sn1.medium

You can also find accurate information from the DescribeAvailableResource interface.

DiskSize Integer Yes 400

The disk size of a node. Unit: GB

The stand-alone version: 20-500GB, step size :1GB;

Cluster Edition Cloud Disk: 400-64,000 GB, step size :40GB

Cluster version sites: strongly related to specifications, as follows:

  • hbase.d1.4xlarge =44000
  • hbase.d1.6xlarge =66000
  • hbase.d1.8xlarge =88000
  • hbase.i2.xlarge =894
  • hbase.i2.2xlarge =1788
  • hbase.i2.4xlarge =3576
  • hbase.i2.8xlarge =7152
  • hbase.d2s.5xlarge =58400
  • hbase.d2s.10xlarge =109500
DiskType String Yes cloud_ssd

The type of the disk. Valid values: cloud_efficiency, cloud_ssd, local_hdd_pro, local_ssd_pro, and cloud_essd_pl1.

Engine String Yes hbase

Service Type: such as hbase, hbaseue, and bds.

EngineVersion String Yes 2.0

Depending on the engine type,

hbase: 1.1, 2.0

hbaseue: 2.0


MasterInstanceType String Yes hbase.sn1.medium You can also find accurate information from the DescribeAvailableResource interface.
NodeCount Integer Yes 2

The number of nodes. Valid values: 1-100. Standalone edition: 1; Cluster Edition Cloud Disk: minimum is 2; Cluster Edition: minimum is 3.

PayType String Yes Prepaid

Payment type Prepaid: subscription Postpaid: Postpaid

RegionId String Yes cn-hangzhou

The ID of the region where Ant Blockchain is used.

SecurityIPList String Yes

The list of whitelists. Example: 192.168. *. */24. If is disabled, multiple values are separated with commas (,).

VpcId String Yes vpc-bp120k6ixs4eog*****

The id of the vpc. If both the and vswitchId parameters are empty, they Classic network. First vpc network

VSwitchId String Yes vsw-bp191ipotqj1ssyl*****

The id of the vswich vSwitch.

ZoneId String Yes cn-hangzhou-f

The ID of the zone.

ColdStorageSize Integer No 1024

The size of the cold storage. If it is equal to 0, the cold storage is not enabled. If it is greater than 0 (800-100000GB, the step size is 10GB), the cold storage is enabled.

PeriodUnit String Yes month

Pre-payment cycle unit:

year: year; month: month.

Period Integer No 6

Subscription period: this parameter takes effect only when PayType=Prepaid.

PeriodUnit=year, the value is 1-5;

PeriodUnit=month, with values from 1 to 9;

AutoRenewPeriod Integer No 2

The auto-renewal cycle. Unit: month. Default value: 0, indicating no auto-renewal,

AutoRenamePeriod=2, indicating two months auto-renewal expiration.

ClientToken String Yes ETnLKlblzczshOTUbOCzxxxxxxxxxx

The token ensuring that making multiple identical requests has the same effect as making a single request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token is case-sensitive and can contain only ASCII characters. It must be 1 to 64 characters in length.

ResourceGroupId String Yes rg-xxxxxxxxxxx

The resource group Id, which can be queried through the resource group console. If not specified, the Id is put into the default resource group.

Response parameters

Field Type Sample response Description
ClusterId String hb-bp1hy2*********

Cluster ID

OrderId String 23232*********

Order id

RequestId String 3E19E345-101D-4014-946C-A205*******

The ID of the request.


Sample requests

     http(s)://[Endpoint]/? 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= &VpcId=vpc-bp120k6ixs4eog ***** &VSwitchId=vsw-bp191ipotqj1ssyl ***** &ZoneId=cn-hangzhou-f &<common request parameters> 

Sample success responses

XML format


JSON Format

    "RequestId": "3E19E345-101D-4014-946C-A205*******",  
    "ClusterId": "hb-bp1hy2*********",  
    "OrderId": "23232*********"

Error codes

The port number of a client that accesses a Error Center For more information, see error codes.