You can call this operation to query the basic information of the cluster.

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 DescribeInstance

The operation that you want to perform. Set the value to DescribeInstance.
ClusterId String Yes hb-bp16f1441y6p2kv**

The ID of the cluster that you want to query.

Response parameters

Parameter Type Example Description
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.
CoreDiskCount String 2

The number of disks for the core node.
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

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. Valid values:

hbase

spark

geomesa

...
ExpireTime String 2019-10-12T14:40:46

The expiration time.
ClusterId String hb-bp16f1441y6p2kv**

The ID of the cluster. It is the unique ID generated by the system.
InstanceName 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.
MaintainEndTime String 4:00

The end time of the maintenance window of the instance.
MaintainStartTime String 2:00

The start time of the maintenance window of the instance.
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

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.
The MinorVersion String 2.0.8

The minor version number.
NetworkType String VPC

The type of the network. Valid values:

VPC

CLASSIC

If the network type is VPC, the values of vSwitchId and vpcId are returned.
PayType String Postpaid

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.
RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4D6**

The ID of the request. It is the unique ID that is dynamically generated for the request.
Status String ACTIVATION

The status of a cluster. Valid values:

CREATING

ACTIVATION

DELETING

RESTARTING
Tags Array

The tags of the resource.
Tag

The tags of the resource.
Key String test_key

The key of the tag.
Value String test_value

The value of the tag.
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-bp191ipotq****dbqf

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.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeInstance
&ClusterId=hb-bp16f1441y6p2kv**
&<Common request parameters>

Sample success responses

XML format 

<ClusterId>hb-bp16o0pd52e3y582s</ClusterId>
<ZoneId>cn-hangzhou-f</ZoneId>
<MasterDiskSize>0</MasterDiskSize>
<VpcId>vpc-bp120k6ixs4eoghz*****</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-bp191ipotq****dbqf</VswitchId>
<CoreDiskSize>100</CoreDiskSize>
<PayType>PayAsYouGo</PayType>
<InstanceName>wangjk-HBase</InstanceName>
<MasterInstanceType>hbase.sn1.medium</MasterInstanceType>
<MaintainEndTime>4:00</MaintainEndTime>
<MaintainStartTime>2:00</MaintainStartTime>
<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>

JSON format 

{
	"ClusterId":"hb-bp16o0pd52e3y582s",
	"ZoneId":"cn-hangzhou-f",
	"MasterDiskSize":0,
	"Engine":"hbase",
	"VpcId":"vpc-bp120k6ixs4eoghz*****",
	"MajorVersion":"2.0",
	"CoreNodeCount":4,
	"NetworkType":"VPC",
	"CoreDiskType":"cloud_ssd",
	"MasterDiskType":"",
	"MaintainStartTime":"2:00",
	"CoreInstanceType":"hbase.sn1.large",
	"VswitchId":"vsw-bp191ipotq****dbqf",
	"CoreDiskSize":100,
	"PayType":"PayAsYouGo",
	"InstanceName":"wangjk-HBase",
	"MasterInstanceType":"hbase.sn1.medium",
	"MaintainEndTime":"4:00",
	"CreatedTime":"2019-09-12T14:40:46",
	"Status":"ACTIVATION",
	"MinorVersion":"2.0.8",
	"ColdStorageStatus":"open",
	"RequestId":"EBECBF12-2E34-41BE-8DE9-FC3700D4D6C6",
	"RegionId":"cn-hangzhou",
	"MasterNodeCount":2,
	"BackupStatus":"open"
}

Error codes

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