All Products
Search

This Product

    ApsaraDB for HBase:CreateCluster

    Document Center

    ApsaraDB for HBase:CreateCluster

    Last Updated:Jan 10, 2024

    Creates an ApsaraDB for HBase cluster.

    Request parameters

    Parameter Type Required Example Description
    Action String Yes CreateCluster

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

    RegionId String Yes cn-hangzhou

    The region ID of the ApsaraDB for HBase cluster. You can call the DescribeRegions operation to query the most recent region list.

    ZoneId String Yes cn-hangzhou-f

    The ID of the zone where the ApsaraDB for HBase cluster is deployed. You can call the DescribeRegions operation to query the most recent zone list.

    ClusterName String Yes hbase_test

    The name of the ApsaraDB for HBase cluster. The following content describes naming conventions:

    • The name must be 2 to 128 characters in length.
    • The name must start with a letter.
    • The name can contain digits, periods (.), hyphens (-), and underscores (_).
    VpcId String Yes vpc-bp120k6ixs4eog****

    The virtual private cloud (VPC) ID.

    Note If you do not specify this parameter and the VSwitchId parameter, the ApsaraDB for HBase cluster resides in the classic network.
    VSwitchId String Yes vsw-bp191otqj1ssyl****

    The ID of the vSwitch that belongs to the VPC.

    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.

    CoreInstanceType String Yes hbase.sn1.medium

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

    DiskType String Yes cloud_ssd

    The disk type of the core nodes of the ApsaraDB for HBase cluster. Valid values:

    • cloud_efficiency: ultra disk.
    • cloud_ssd: SSD.
    • local_hdd_pro: local HDD.
    • local_ssd_pro: local SSD.
    • cloud_essd_pl1: enhanced SSD (ESSD).
    DiskSize Integer Yes 400

    The disk size of the core node. Unit: GB.

    • If the ApsaraDB for HBase cluster is a single-node cluster, the disk size of the core node ranges from 20 GB to 500 GB and the step size is 1 GB.
    • If the ApsaraDB for HBase cluster uses disks, the disk size of the core node ranges from 400 GB to 64,000 GB and the step size is 40 GB.

    • If the ApsaraDB for HBase cluster uses local disks, the disk size of the core node is related to the instance type of the core node. The following content provides the details:

      • If the instance type of the core node is hbase.d1.4xlarge, the disk size of the core node is 44,000 GB.
      • If the instance type of the core node is hbase.d1.6xlarge, the disk size of the core node is 66,000 GB.
      • If the instance type of the core node is hbase.d1.8xlarge, the disk size of the core node is 88,000 GB.
      • If the instance type of the core node is hbase.i2.xlarge, the disk size of the core node is 894 GB.
      • If the instance type of the core node is hbase.i2.2xlarge, the disk size of the core node is 1,788 GB.
      • If the instance type of the core node is hbase.i2.4xlarge, the disk size of the core node is 3,576 GB.
      • If the instance type of the core node is hbase.i2.8xlarge, the disk size of the core node is 7,152 GB.
      • If the instance type of the core node is hbase.d2s.5xlarge, the disk size of the core node is 58,400 GB.
      • If the instance type of the core node is hbase.d2s.10xlarge, the disk size of the core node is 109,500 GB.
    NodeCount Integer Yes 2

    The number of core nodes.

    • If the ApsaraDB for HBase cluster is a single-node cluster, set the number of core nodes to 1.
    • If the ApsaraDB for HBase cluster uses disks, set the number of core nodes to an integer that ranges from 2 to 100.
    • If the ApsaraDB for HBase cluster uses local disks, set the number of core nodes to an integer that ranges from 4 to 100.
    PayType String Yes Prepaid

    The billing method of the ApsaraDB for HBase cluster. Valid values:

    • Prepaid: The subscription billing method is used.
    • Postpaid: The pay-as-you-go billing method is used.
    Engine String Yes hbase

    The database engine type. Valid values:

    • hbase: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase Standalone Edition.
    • hbaseue: ApsaraDB for HBase Performance-enhanced Edition.
    • bds: BDS instance.
    SecurityIPList String Yes 116.62.XX.XX/24

    The IP addresses or CIDR blocks that you want to add to the whitelist of the ApsaraDB for HBase cluster. If you specify multiple IP addresses or CIDR blocks, separate them with commas (,).

    Note If you specify 127.0.0.1, access from all IP addresses is denied. If you specify 192.168.0.0/24, IP addresses in the 192.168.0.XX format are allowed to access the ApsaraDB for HBase cluster.
    EngineVersion String Yes 2.0

    The engine version of the ApsaraDB for HBase cluster. It is related to the engine type of the ApsaraDB for HBase cluster. Valid values:

    • If the engine type of the ApsaraDB for HBase cluster is hbase, set the engine version of the ApsaraDB for HBase cluster to 1.1 or 2.0.
    • If the engine type of the ApsaraDB for HBase cluster is hbaseue, set the engine version of the ApsaraDB for HBase cluster to 2.0.
    • If the engine type of the ApsaraDB for HBase cluster is bds, set the engine version of the ApsaraDB for HBase cluster to 1.0.
    ColdStorageSize Integer No 1024

    The cold storage size of the ApsaraDB for HBase cluster. Unit: GB. Valid values:

    • 0: Cold storage is not enabled.
    • 800 to 1000000: Cold storage is enabled.
    Note The cold storage feature can take effect only when the engine type of the ApsaraDB for HBase cluster is hbaseue.
    PeriodUnit String No month

    The unit of the subscription duration. Valid values:

    • year
    • month
    Note This parameter is required only when you set PayType to Prepaid.
    Period Integer No 6

    The duration of the subscription. Valid values:

    • If PeriodUnit is set to year, set Period to 1, 2, or 3.
    • If PeriodUnit is set to month, set Period to an integer than ranges from 1 to 9.
    Note This parameter is required only when you set PayType to Prepaid.
    AutoRenewPeriod Integer No 2

    The duration for which the system automatically renews the ApsaraDB for HBase cluster after the cluster expires. Unit: month.

    Note
    • The default value of this parameter is 0. This value specifies that the system does not automatically renew the ApsaraDB for HBase cluster after the cluster expires.
    • For example, if this parameter is set to 2, the system automatically renews the ApsaraDB for HBase cluster for a two-month duration after the cluster 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 token, but you must make sure that the token is unique among different requests. 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. For more information, see View basic information of a resource group.

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

    The ID of the encryption key. If encryption is disabled, this parameter is not returned.

    Note If encryption is enabled for the ApsaraDB for HBase cluster that uses disks, encryption cannot be disabled for this cluster.

    Response parameters

    Parameter Type Example Description
    RequestId String 3E19E345-101D-4014-946C-A205

    The request ID.

    OrderId String 23232069786****

    The order ID.

    ClusterId String hb-bp1hy2sjf8gd****

    The ID of the ApsaraDB for HBase cluster.

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

    Sample success responses

    XML format

    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 format

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

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

    Error codes

    For a list of error codes, see Service error codes.