DescribeAvailableResource - OpenAPI Reference| Alibaba Cloud Documentation Center

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	DescribeAvailableResource	The operation that you want to perform. Set the value to DescribeAvailableResource.
ChargeType	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-shanghai	The ID of the region.
ZoneId	String	No	cn-shanghai-d	The ID of the zone.
Engine	String	No	hbaseue	hbase hbaseue singlehbase bds
EngineVersion	String	No	2.0	hbase: 1.1, 2.0 hbaseue: 2.0 bds: 1.0 singlehbase: 1.1, 2.0
CoreInstanceType	String	No	hbase.sn1.large	hbase.sn1.large For more information, see Instance types.
DiskType	String	No	cloud_ssd	cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd_pl1: enhanced SSD (ESSD) local_hdd_pro: throughput-intensive local disk local_ssd_pro: I/O-intensive local disk

Response parameters


Parameter	Type	Example	Description
AvailableZones	Array of AvailableZone		The list of zones.
AvailableZone
MasterResources	Array of MasterResource		The list of master nodes.
MasterResource
InstanceType	String	hbase.sn1.medium	The instance type.
InstanceTypeDetail	Struct		The description of the instance type.
Cpu	Integer	4	The number of CPU cores.
Mem	Integer	8	The memory size. Unit: GB.
RegionId	String	cn-shenzhen	The ID of the region.
SupportedEngines	Array of SupportedEngine		The supported engines.
SupportedEngine
Engine	String	hbase	The engine.
SupportedEngineVersions	Array of SupportedEngineVersion		The supported engine version.
SupportedEngineVersion
SupportedCategories	Array of SupportedCategories		The supported categories.
SupportedCategories
Category	String	cluster	The category of the instance. ApsaraDB for HBase instances can run in single-node mode or in cluster mode.
SupportedStorageTypes	Array of SupportedStorageType		The storage type.
SupportedStorageType
CoreResources	Array of CoreResource		The list of core nodes.
CoreResource
DBInstanceStorageRange	Struct		The range of the storage size.
MaxSize	Integer	8000	The maximum storage size. Unit: GB.
MinSize	Integer	400	The minimum storage size. Unit: GB.
StepSize	Integer	40	The step size. Unit: GB.
InstanceType	String	hbase.sn1.large	The instance type.
InstanceTypeDetail	Struct		The details of the instance type.
Cpu	Integer	4	The number of CPU cores.
Mem	Integer	8	The memory size. Unit: GB.
MaxCoreCount	Integer	16	The maximum number of nodes in the inventory.
StorageType	String	cloud_ssd	The storage type.
Version	String	2.0	The version number.
ZoneId	String	cn-shenzhen-e	The ID of the zone.
RequestId	String	ABCD-***********	The ID of the request.

Examples

Sample requests

http(s)://hbase.aliyuncs.com/?Action=DescribeAvailableResource
&ChargeType=Prepaid
&RegionId=cn-shenzhen
&<Common request parameters>

Sample success responses

XML format

<RequestId>ABCD-***********</RequestId>
<AvailableZones>
    <AvailableZone>
        <ZoneId>cn-shenzhen-e</ZoneId>
        <RegionId>cn-shenzhen</RegionId>
    </AvailableZone>
    <AvailableZone>
        <SupportedEngines>
            <SupportedEngine>
                <Engine>hbase</Engine>
            </SupportedEngine>
            <SupportedEngine>
                <SupportedEngineVersions>
                    <SupportedEngineVersion>
                        <Version>2.0</Version>
                    </SupportedEngineVersion>
                    <SupportedEngineVersion>
                        <SupportedCategories>
                            <SupportedCategories>
                                <Category>cluster</Category>
                            </SupportedCategories>
                            <SupportedCategories>
                                <SupportedStorageTypes>
                                    <SupportedStorageType>
                                        <StorageType>cloud_ssd</StorageType>
                                    </SupportedStorageType>
                                    <SupportedStorageType>
                                        <CoreResources>
                                            <CoreResource>
                                                <InstanceType>hbase.sn1.large</InstanceType>
                                                <MaxCoreCount>16</MaxCoreCount>
                                            </CoreResource>
                                            <CoreResource>
                                                <DBInstanceStorageRange>
                                                    <MinSize>400</MinSize>
                                                    <StepSize>40</StepSize>
                                                    <MaxSize>8000</MaxSize>
                                                </DBInstanceStorageRange>
                                                <InstanceTypeDetail>
                                                    <Mem>8</Mem>
                                                    <Cpu>4</Cpu>
                                                </InstanceTypeDetail>
                                            </CoreResource>
                                        </CoreResources>
                                    </SupportedStorageType>
                                </SupportedStorageTypes>
                            </SupportedCategories>
                        </SupportedCategories>
                    </SupportedEngineVersion>
                </SupportedEngineVersions>
            </SupportedEngine>
        </SupportedEngines>
        <MasterResources>
            <MasterResource>
                <InstanceType>hbase.sn1.medium</InstanceType>
            </MasterResource>
            <MasterResource>
                <InstanceTypeDetail>
                    <Mem>8</Mem>
                    <Cpu>4</Cpu>
                </InstanceTypeDetail>
            </MasterResource>
        </MasterResources>
    </AvailableZone>
</AvailableZones>

JSON format

{"RequestId":"ABCD-***********","AvailableZones":{"AvailableZone":[{"ZoneId":"cn-shenzhen-e","RegionId":"cn-shenzhen"},{"SupportedEngines":{"SupportedEngine":[{"Engine":"hbase"},{"SupportedEngineVersions":{"SupportedEngineVersion":[{"Version":"2.0"},{"SupportedCategories":{"SupportedCategories":[{"Category":"cluster"},{"SupportedStorageTypes":{"SupportedStorageType":[{"StorageType":"cloud_ssd"},{"CoreResources":{"CoreResource":[{"InstanceType":"hbase.sn1.large","MaxCoreCount":"16"},{"DBInstanceStorageRange":{"MinSize":"400","StepSize":"40","MaxSize":"8000"},"InstanceTypeDetail":{"Mem":"8","Cpu":"4"}}]}}]}}]}}]}}]},"MasterResources":{"MasterResource":[{"InstanceType":"hbase.sn1.medium"},{"InstanceTypeDetail":{"Mem":"8","Cpu":"4"}}]}}]}}

Error codes

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