Creates an ApsaraDB for HBase instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateCluster

The operation that you want to perform. Set the value to CreateCluster.

ClusterName String Yes hbase_test

The name of the instance.

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 call the DescribeAvailableResource operation to obtain the value of this parameter.

DiskSize Integer Yes 400

The disk size of the node. Unit: GB.

For ApsaraDB for HBase in single-node mode, the disk size ranges from 20 GB to 500 GB and the step size is 1 GB.

For ApsaraDB for HBase that runs in cluster mode and uses disks, the disk size ranges from 400 GB to 64,000 GB and the step size is 40 GB.

For ApsaraDB for HBase that runs in cluster mode and uses local disks, the disk size varies by instance type. The following list provides the mappings between disks sizes and instance types:

  • 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
  • cloud_essd_pl1
Engine String Yes hbase

The type of the service. Valid values:

  • hbase
  • hbaseue
  • bds
EngineVersion String Yes 2.0

The version of the engine. Valid values:

  • hbase:1.1, 2.0
  • hbaseue:2.0
  • bds:1.0
MasterInstanceType String Yes hbase.sn1.medium

The instance type of the master node. You can call the DescribeAvailableResource operation to obtain the value of this parameter.

NodeCount Integer Yes 2

The number of nodes. Valid values: 1 to 100.

  • ApsaraDB for HBase in single-node mode: one node
  • ApsaraDB for HBase that runs in cluster mode and uses disks: at least two nodes
  • ApsaraDB for HBase that runs in cluster mode and uses local disks: at least three nodes
PayType String Yes Prepaid

The billing method.

  • Prepaid: The subscription billing method is used.
  • Postpaid: The pay-as-you-go billing method is used.
RegionId String Yes cn-hangzhou

The ID of the region.

SecurityIPList String Yes 127.0.0.1

The IP addresses in the whitelist. Example: 192.168.*.*/24. The 0.0.0.0/0 value cannot be added to the whitelist. Separate multiple IP addresses with commas (,).

VpcId String Yes vpc-bp120k6ixs4eog****

The ID of the virtual private cloud (VPC). If you leave this parameter and the VSwitchId parameter empty, the classic network type is used. The VPC network type is preferred.

VSwitchId String Yes vsw-bp191otqj1ssyl****

The ID of the vSwitch.

ZoneId String Yes cn-hangzhou-f

The ID of the zone.

ColdStorageSize Integer No 1024

The size of cold data storage.

  • If this parameter is set to 0, cold data storage is disabled.
  • If this parameter is set to a value greater than 0, cold data storage is enabled. The storage size ranges from 800 GB to 100,000 GB and the step size is 10 GB.
PeriodUnit String No month

The unit of the subscription period. Valid values:

  • year
  • month
Period Integer No 6

The subscription period.

  • This parameter only takes effect when the PayType parameter is set to Prepaid.
  • When the PeriodUnit parameter is set to year, the value of the Period parameter ranges from 1 to 5.
  • When the PeriodUnit parameter is set to month, the value of the Period parameter ranges from 1 to 9.
AutoRenewPeriod Integer No 2

The auto-renewal period. Unit: month.

  • The default value of this parameter is 0. This value indicates that auto-renewal is disabled.
  • If this parameter is set to 2, the instance is automatically renewed for a two-month subscription after the instance expires.
ClientToken String No ETnLKlblzczshOTUbOCz****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ResourceGroupId String No rg-j4d53glb3****

The ID of the resource group. You can query the group ID in the resource group console. If you leave this parameter empty, the instance is allocated to the default resource group.

Response parameters

Parameter Type Example Description
ClusterId String hb-bp1hy2sjf8gd****

The ID of the instance.

OrderId String 23232069786****

The ID of the order.

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

The ID of the request.

Examples

Sample requests

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=127.0.0.1
&VpcId=vpc-bp120k6ixs4eog****
&VSwitchId=vsw-bp191ipotqj1ssyl****
&ZoneId=cn-hangzhou-f
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.