You can call this operation to query the cluster list by page.

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
PageNumber Integer No 1

The number of the page to return. Starting value: 1.

Default value: 1.
PageSize Integer No 10

The number of entries to return on each page. Maximum value: 100.

Default value: 10.
RegionId String No cn-hangzhou

The ID of the region to which the instance belongs. You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
Instances Array

The list of clusters.
Instance

The list of clusters.
BackupStatus String open

Indicates the backup and restoration status. Valid values:

open: The backup and restoration status is displayed.

close: The backup and restoration status is not displayed.
ColdStorageStatus String open

Indicates whether cold data and hot data are stored separately. Valid values:

open: Cold data and hot data are stored separately.

close: Cold data and hot data are not stored separately.
CoreDiskSize Integer 100

The disk size of the core node. Unit: GB.
CoreDiskType String cloud_efficiency

The disk type of the core node. Valid values: cloud_efficiency and cloud_ssd.
CoreInstanceType String hbase.sn1.large

The instance type of the core node.
CoreNodeCount Integer 2

The number of core nodes.
CreatedTime String 2019-09-12T14:40:46

The time when the cluster was created.
Engine String hbase

The product engine, such as hbase, spark, or geomesa.
ExpireTime String hb-bp16f1441y6p2kv**

The expiration time.
ClusterId String hb-bp16f1441y6p2kv**

The ID of the cluster. It is the unique ID generated by the system.
ClusterName String openapi-test

The name of the cluster. You can set this parameter as needed.
IsHa Boolean true

Indicates whether the cluster is highly available. Valid values: true and false.
MajorVersion String 2.0

The major version number.
MasterDiskSize Integer 100

The disk size of the master node. Unit: GB.
MasterDiskType String cloud_efficiency

The disk type of the master node. Valid values: cloud_efficiency and cloud_ssd.
MasterInstanceType String hbase.sn1.large

The instance type of the master node.
MasterNodeCount Integer 2

The number of master nodes. If the master node is a single node, the returned value is 0. If the master node is a high availability node, the returned value is 2.

NetworkType String VPC

The type of the network. Valid values: VPC and CLASSIC. If the network type is VPC, the values of vSwitchId and vpcId are returned.

PayType String Prepaid

The billing method of the cluster. Valid values:

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

The region ID of the instance.
Status String ACTIVATION

The status of a cluster. Valid values: CREATING, ACTIVATION, DELETING, and RESTARTING.
VpcId String vpc-bp120k6ixs4eoghz*****

The ID of the VPC. When the value of NetworkType is VPC, this value is returned. Example: vpc-xxxx.

VswitchId String vsw-bp191ipotqdbqf****

The ID of the VSwitch. When the value of NetworkType is VPC, this value is returned. Example: vsw-xxxx.

ZoneId String cn-hangzhou-f

The zone ID of the instance.
PageNumber Integer 1

The number of the returned page.
PageSize Integer 10

The number of entries returned per page.
RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4D6**

The ID of the request. It is the unique ID that is dynamically generated for the request.
TotalCount Long 18

The total number of entries.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeInstances
&<Common request parameters>

Sample success responses

XML format 

<PageNumber>1</PageNumber>
<TotalCount>9</TotalCount>
<PageSize>10</PageSize>
<RequestId>4871E1AF-BAB2-41B6-B9D6-41717861F443</RequestId>
<Instances>
    <Instance>
        <ClusterId>hb-bp16o0pd52e3y582s</ClusterId>
        <ZoneId>cn-hangzhou-f</ZoneId>
        <MasterDiskSize>0</MasterDiskSize>
        <VpcId>vpc-bp120k6ixs4eoghzwvu6x</VpcId>
        <Engine>hbase</Engine>
        <MajorVersion>2.0</MajorVersion>
        <CoreNodeCount>4</CoreNodeCount>
        <NetworkType>VPC</NetworkType>
        <CoreDiskType>cloud_ssd</CoreDiskType>
        <MasterDiskType/>
        <CoreInstanceType>hbase.sn1.large</CoreInstanceType>
        <VswitchId>vsw-bp191ipotqj1ssyl7dbqf</VswitchId>
        <CoreDiskSize>100</CoreDiskSize>
        <PayType>PayAsYouGo</PayType>
        <ClusterName>wangjk-HBase</ClusterName>
        <MasterInstanceType>hbase.sn1.medium</MasterInstanceType>
        <CreatedTime>2019-09-12T14:40:46</CreatedTime>
        <Status>ACTIVATION</Status>
        <MinorVersion>2.0.8</MinorVersion>
        <ColdStorageStatus>open</ColdStorageStatus>
        <RequestId>EBECBF12-2E34-41BE-8DE9-FC3700D4D6C6</RequestId>
        <RegionId>cn-hangzhou</RegionId>
        <MasterNodeCount>2</MasterNodeCount>
        <BackupStatus>open</BackupStatus>
    </Instance>
    </Instance>
</Instances>

JSON format 

{
	"PageNumber":1,
	"TotalCount":9,
	"PageSize":10,
	"RequestId":"4871E1AF-BAB2-41B6-B9D6-41717861F443",
	"Instances":{
		"Instance":[
			{
				"CreatedTime":"2019-09-12T14:40:46",
				"ClusterId":"hb-bp16o0pd52e3y582s",
				"ZoneId":"cn-hangzhou-f",
				"MasterDiskSize":0,
				"VpcId":"vpc-bp120k6ixs4eoghzwvu6x",
				"Engine":"hbase",
				"MajorVersion":"2.0",
				"CoreNodeCount":4,
				"Status":"ACTIVATION",
				"NetworkType":"VPC",
				"CoreDiskType":"cloud_ssd",
				"MinorVersion":"2.0.8",
				"ColdStorageStatus":"open",
				"MasterDiskType":"",
				"RegionId":"cn-hangzhou",
				"RequestId":"EBECBF12-2E34-41BE-8DE9-FC3700D4D6C6",
				"CoreInstanceType":"hbase.sn1.large",
				"MasterNodeCount":2,
				"VswitchId":"vsw-bp191ipotqj1ssyl7dbqf",
				"BackupStatus":"open",
				"CoreDiskSize":100,
				"ClusterName":"wangjk-HBase",
				"PayType":"PayAsYouGo",
				"MasterInstanceType":"hbase.sn1.medium"
			},
			{}
		]
	}
}

Error codes

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