Queries whether an ApsaraDB for HBase cluster that is deployed across multiple zones has available resources.

Request parameters

Parameter Type Required Example Description
Action String Yes EvaluateMultiZoneResource

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

Engine String Yes hbaseue

The type of engine. This parameter takes effect only on ApsaraDB for HBase Performance-enhanced Edition. Set the value to hbaseue.

EngineVersion String Yes 2.0

The version of the engine. Set the value to 2.0.

ArchVersion String Yes 2.0

The version of the deployment architecture. This parameter only takes effect if you specify hbaseue for Engine. Set the value to 2.0.

ClusterName String Yes hbaseue_test

The name of the ApsaraDB for HBase cluster. The specified name must meet the following requirements:

  • 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 (_).
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.

VpcId String Yes vpc-bp120k6ixs4eog*****

The ID of the virtual private cloud (VPC). The VPC must be deployed in the region specified by the RegionId parameter.

MultiZoneCombination String Yes cn-hangzhou-bef-aliyun-com

The combination of zones.

PrimaryZoneId String Yes cn-hangzhou-e

The ID of the zone where the primary instance is deployed.

PrimaryVSwitchId String Yes vsw-hangxzhouxe*****

The ID of the vSwitch that is specified for the primary instance. The vSwitch must be deployed in the zone specified by the PrimaryZoneId parameter.

StandbyZoneId String Yes cn-hangzhou-f

The ID of the zone where the secondary instance is deployed.

StandbyVSwitchId String Yes vsw-hangxzhouxf****

The ID of the vSwitch that is specified for the secondary instance. The vSwitch must be deployed in the zone specified by the StandbyZoneId parameter.

ArbiterZoneId String Yes cn-hangzhou-b

The ID of the zone where the arbiter is deployed.

ArbiterVSwitchId String Yes vsw-hangxzhouxb****

The ID of the vSwitch that is specified for the arbiter. The vSwitch must be deployed in the zone specified by the ArbiterZoneId parameter.

MasterInstanceType String Yes hbase.sn1.medium

The instance type of the master node. You can call the DescribeInstanceType operation to query the instance type of the master node.

CoreInstanceType String Yes hbase.sn1.medium

The instance type of the core nodes. You can call the DescribeInstanceType operation to query the instance type of the core nodes.

CoreDiskType String Yes cloud_ssd

The disk type of the core nodes. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • local_hdd_pro: throughput-intensive local disk
  • local_ssd_pro: I/O-intensive local disk
CoreDiskSize Integer Yes 400

The disk size of each core node. The valid values range from 400 to 64000. Unit: GB. Step size: 40.

CoreNodeCount Integer Yes 4

The number of core nodes. The valid values range from 2 to 20. Step size: 2.

LogInstanceType String Yes hbase.sn1.medium

The instance type of the log nodes. You can call the DescribeInstanceType operation to query the instance type of the log nodes.

LogDiskType String Yes cloud_ssd

The disk type of the log nodes. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • local_hdd_pro: throughput-intensive local disk
  • local_ssd_pro: I/O-intensive local disk
LogDiskSize Integer Yes 400

The disk size of each log node. The valid values range from 400 to 64000. Unit: GB. Step size: 40.

LogNodeCount Integer Yes 4

The number of log nodes. The valid values range from 4 to 400. The specified value must be a multiple of 4.

SecurityIPList String Yes 127.0.0.1

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.
PayType String Yes Postpaid

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.
PeriodUnit String No month

The unit of the subscription duration. Valid values:

  • year: The unit of the subscription duration is year.
  • month: The unit of the subscription duration is month.
Note This parameter is only required when you specify Prepaid for PayType.
Period Integer No 1

The duration of the subscription. Valid values:

  • If PeriodUnit is set to year, the valid values of the Period parameter are 1, 2, and 3.
  • If PeriodUnit is set to month, the valid values of the Period parameter are integers that range from 1 to 9.
Note This parameter is only required when you specify Prepaid for PayType.
AutoRenewPeriod Integer No 0

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.
  • 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 f4g8t5rd2gr94****

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 ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

Response parameters

Parameter Type Example Description
Success Boolean true

Indicates whether the ApsaraDB for HBase cluster has available resources. Valid values:

  • true: indicates that the ApsaraDB for HBase cluster has available resources.
  • false: indicates that the ApsaraDB for HBase cluster does not have available resources.
RequestId String FB703B69-D4D4-4879-B9FE-6A37F67C46FD

The ID of the request.

Examples

Sample requests

http(s)://hbase.aliyuncs.com/?Action=EvaluateMultiZoneResource
&ArbiterVSwitchId=vsw-hangxzhouxb*****
&ArbiterZoneId=cn-hangzhou-b
&ArchVersion=2.0
&ClusterName=hbaseue_test
&CoreDiskSize=400
&CoreDiskType=cloud_ssd
&CoreInstanceType=hbase.sn1.medium
&CoreNodeCount=4
&Engine=hbaseue
&EngineVersion=2.0
&LogDiskSize=400
&LogDiskType=cloud_ssd
&LogInstanceType=hbase.sn1.medium
&LogNodeCount=4
&MasterInstanceType=hbase.sn1.medium
&MultiZoneCombination=cn-hangzhou-bef-aliyun-com
&PayType=Postpaid
&PrimaryVSwitchId=vsw-hangxzhouxe*****
&PrimaryZoneId=cn-hangzhou-e
&RegionId=cn-hangzhou
&SecurityIPList=127.0.0.1
&StandbyVSwitchId=vsw-hangxzhouxf****
&StandbyZoneId=cn-hangzhou-f
&VpcId=vpc-bp120k6ixs4eog*****
&<Common request parameters>

Sample success responses

XML format 

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

<RequestId>FB703B69-D4D4-4879-B9FE-6A37F67C46FD</RequestId>
<Success>true</Success>

JSON format 

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

{
  "RequestId" : "FB703B69-D4D4-4879-B9FE-6A37F67C46FD",
  "Success" : true
}

Error codes

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