Queries available resources.

Debugging

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

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 of the instance. Prepaid,PostPaid
RegionId String Yes cn-shanghai

A region unit.
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

Node specifications
DiskType String No cloud_ssd

cloud_efficiency,cloud_ssd,cloud_essd_pl1,local_hdd_pro,local_ssd_pro.

Response parameters

Parameter Type Example Description
AvailableZones Array of AvailableZone

The list of available zones, which is an array of Zone data.
AvailableZone
MasterResources Array of MasterResource

Manage node list.
MasterResource
InstanceType String hbase.sn1.medium

The specifications.
InstanceTypeDetail Struct

The description of the specifications.
Cpu Integer 4

The number of cpu cores.
Mem Integer 8

The memory size. Unit: GB.
RegionId String cn-shenzhen

A region unit.
SupportedEngines Array of SupportedEngine

The supported engines.
SupportedEngine
Engine String hbase

The engine.
SupportedEngineVersions Array of SupportedEngineVersion

The engine version is supported.
SupportedEngineVersion
SupportedCategories Array of SupportedCategories

Supported categories.
SupportedCategories
Category String cluster

Category, Cluster Edition, single-host edition
SupportedStorageTypes Array of SupportedStorageType

The type of the storage.
SupportedStorageType
CoreResources Array of CoreResource

The resources of work nodes.
CoreResource
DBInstanceStorageRange Struct

The storage range.
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 specifications.
InstanceTypeDetail Struct

The details of the specifications.
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 inventory.
StorageType String cloud_ssd

The type of the storage.
Version String 2.0

The version number.
ZoneId String cn-shenzhen-e

The IDs of zones.
RequestId String ABCD-***********

The ID of the request.

Examples

Sample requests


     http(s)://[Endpoint]/? 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

Go to the Error Center For more information, see error codes.