Queries detailed information about ApsaraDB for HBase instances in a specified region.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstances

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

RegionId String No cn-hangzhou

The region ID of the instance whose information you want to query. You can call the DescribeRegions operation to query the most recent region list.

Note This parameter is required if you specify the Tag.N.Key and Tag.N.Value parameters when you call the operation.
PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer No 10

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

DbType String No hbase

The type of the service. Valid values:

  • hbase: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase Standalone Edition
  • hbaseue: ApsaraDB for HBase Performance-enhanced Edition
  • bds: a Lindorm Tunnel Service (LTS) instance
ClusterName String No test

The name of the ApsaraDB for HBase instance.

ClusterId String No hb-bp1u0639js2h7****

The ID of the instance. You can call the DescribeInstances operation to query the instance ID.

ResourceGroupId String No rg-4f51d54g5****

The ID of the resource group. You can obtain this ID on the Resource Group page in the Resource Management console.

Tag.N.Key String No key

The key of tag N of the instance. A tag is a key-value pair in the format of {"key1":"value1","key2":"value2"}.

Tag.N.Value String No value

The value of tag N of the instance. A tag is a key-value pair.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned on each page.

RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4****

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Long 18

The total number of instances that were queried.

Instances Array of Instance

Detailed information about the ApsaraDB for HBase instances.

Instance
VpcId String vpc-bp120k6ixs4eoghz*****

The ID of the virtual private cloud (VPC). This parameter is returned only when the value of the NetworkType parameter is set to 2.

Status String ACTIVATION

The state of the instance. Valid values:

  • CREATING: The instance is being created.
  • ACTIVATION: The instance is running.
  • DELETING: The instance is being deleted.
  • RESTARTING: The instance is restarting.
  • MINOR_VERSION_TRANSING: The minor version of the instance is being updated.
ModuleId Integer 0

The ID of the module.

VswitchId String vsw-bp191ipotq****dbqf

The ID of the vSwitch. This parameter is returned only when the value of the NetworkType parameter is set to 2.

BackupStatus String open

Indicates whether the backup feature is enabled for the instance.

  • open: The backup feature is enabled for the instance.
  • close: The backup feature is disabled for the instance.
PayType String Prepaid

The billing method of the instance. Valid values:

  • Prepaid: subscription
  • Postpaid: pay-as-you-go
CoreDiskType String cloud_efficiency

The disk type of the core node. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • local_hdd: local HDD
  • local__ssd: local SSD
MasterNodeCount Integer 2

Indicates the type of the master node. Valid values:

  • 0: standalone node
  • 2: cluster node
NetworkType String VPC

The network type of the instance. Valid values:

  • VPC: virtual private cloud (VPC). If the network type is VPC, the VswitchId parameter and VpcId parameter are returned.
  • CLASSIC: classic network
CreatedTimeUTC String 2019-09-12T14:40:46Z

The point in time when the instance was created. The time is displayed in UTC.

ParentId String 2980****2123

The ID of the parent instance.

ExpireTimeUTC String 2019-10-12T14:40:46Z

The point in time when the instance expires. The time is displayed in UTC.

InstanceName String test

The name of the instance.

MasterInstanceType String hbase.sn1.large

The instance type of the master nodes.

CoreInstanceType String hbase.sn1.large

The instance type of the core nodes.

CreatedTime String 2019-09-12T14:40:46

The point in time when the instance was created.

CoreDiskSize Integer 100

The disk capacity of each core node. Unit: GB.

ClusterId String hb-bp1u0639js2h7****

The ID of the instance.

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

The point in time when the instance expires.

IsHa Boolean true

Indicates whether the instance is highly available. Valid values:

  • true: The instance is highly available.
  • false: The instance is not highly available.
Note By default, if the instance is a cluster instance, the instance contains two master nodes to ensure high availability. If the instance is a standalone instance, the instance contains one node. In this case, the storage capacity of the instance equals the storage capacity of the disk that is mounted to the node.
InstanceId String hb-bp1u0639js2h7****

The ID of the instance.

ColdStorageStatus String open

Indicates whether the cold storage feature is enabled for the instance. Valid values:

  • open: The cold storage feature is enabled for the instance.
  • close: The cold storage feature is disabled for the instance.
IsDeletionProtection Boolean true

Indicates whether the deletion protection feature is enabled for the instance. Valid values:

  • true: The deletion protection feature is enabled.
  • false: The deletion protection feature is disabled.
RegionId String cn-hangzhou

The ID of the region in which the instance is located.

MasterDiskSize Integer 100

The disk capacity of the master node. Unit: GB.

MasterDiskType String cloud_efficiency

The disk type of the master node. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
Note This parameter is returned only when the instance is a standalone instance.
AutoRenewal Boolean false

Indicates whether the auto-renewal feature is enabled for the instance. Valid values:

  • true: The auto-renewal feature is enabled for the instance.
  • false: The auto-renewal feature is disabled for the instance.
Note This parameter is returned only if the instance is a subscription instance.
ClusterType String cluster

The type of the instance. Valid values:

  • cluster: The instance is a cluster instance.
  • single: The instance is a standalone instance.
ResourceGroupId String rg-4f51d54g5****

The ID of the resource group.

ClusterName String test

The name of the instance.

ZoneId String cn-hangzhou-f

The zone ID of the instance.

Duration Integer 12

The auto-renewal duration of the instance. Valid values:

  • Monthly subscription: The auto-renewal duration is one month.
  • Annual subscription: The auto-renewal duration is one year (12 months).
Note This parameter is returned only if the instance is a subscription instance.
ModuleStackVersion String 1.0

The version of the module.

Engine String hbase

The type of the database engine. Valid values:

  • hbase: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase Standalone Edition
  • hbaseue: ApsaraDB for HBase Performance-enhanced Edition
  • serverlesshbase: ApsaraDB for HBase Serverless Edition
  • bds: a Lindorm Tunnel Service (LTS) instance
MajorVersion String 2.0

The major version.

CoreDiskCount String 2

The number of disks of each core node.

CoreNodeCount Integer 2

The number of core nodes.

Tags Array of Tag

The tag of the instance.

Tag
Key String test-key

The tag key

Value String test-value

The tag value.

Examples

Sample requests

http(s)://hbase.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&ClusterId=hb-bp1u0639js2h7****
&<Common request parameters>

Sample success response

XML format

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

<DescribeInstancesResponse>
<Instances>
    <Instance>
        <ModuleStackVersion>1.0</ModuleStackVersion>
        <IsHa>true</IsHa>
        <CreatedTime>2019-09-12T14:40:46</CreatedTime>
        <ResourceGroupId>rg-4f51d54g5****</ResourceGroupId>
        <MasterInstanceType>hbase.sn1.large</MasterInstanceType>
        <IsDeletionProtection>true</IsDeletionProtection>
        <ModuleId>0</ModuleId>
        <NetworkType>VPC</NetworkType>
        <CoreInstanceType>hbase.sn1.large</CoreInstanceType>
        <ClusterName>test</ClusterName>
        <MasterDiskType>cloud_efficiency</MasterDiskType>
        <Engine>hbase</Engine>
        <CoreDiskCount>2</CoreDiskCount>
        <ParentId>2980****2123</ParentId>
        <MajorVersion>2.0</MajorVersion>
        <Status>ACTIVATION</Status>
        <ExpireTimeUTC>2019-10-12T14:40:46Z</ExpireTimeUTC>
        <MasterDiskSize>100</MasterDiskSize>
        <ZoneId>cn-hangzhou-f</ZoneId>
        <ClusterId>hb-bp1u0639js2h7****</ClusterId>
        <CoreNodeCount>2</CoreNodeCount>
        <InstanceId>hb-bp1u0639js2h7****</InstanceId>
        <ColdStorageStatus>open</ColdStorageStatus>
        <CreatedTimeUTC>2019-09-12T14:40:46Z</CreatedTimeUTC>
        <Duration>12</Duration>
        <ClusterType>cluster</ClusterType>
        <PayType>Prepaid</PayType>
        <VswitchId>vsw-bp191ipotq****dbqf</VswitchId>
        <MasterNodeCount>2</MasterNodeCount>
        <InstanceName>test</InstanceName>
        <AutoRenewal>false</AutoRenewal>
        <VpcId>vpc-bp120k6ixs4eoghz****</VpcId>
        <CoreDiskType>cloud_efficiency</CoreDiskType>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2019-10-12T14:40:46</ExpireTime>
        <BackupStatus>open</BackupStatus>
        <CoreDiskSize>100</CoreDiskSize>
    </Instance>
    <Instance>
        <Tags>
            <Tag>
                <Value>test-value</Value>
                <Key>test-key</Key>
            </Tag>
        </Tags>
    </Instance>
</Instances>
<TotalCount>18</TotalCount>
<PageSize>10</PageSize>
<RequestId>EBECBF12-2E34-41BE-8DE9-FC3700D4****</RequestId>
<PageNumber>1</PageNumber>
</DescribeInstancesResponse>

JSON format

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

{
  "Instances" : {
    "Instance" : [ {
      "ModuleStackVersion" : 1,
      "IsHa" : true,
      "CreatedTime" : "2019-09-12T14:40:46",
      "ResourceGroupId" : "rg-4f51d54g5****",
      "MasterInstanceType" : "hbase.sn1.large",
      "IsDeletionProtection" : true,
      "ModuleId" : 0,
      "NetworkType" : "VPC",
      "CoreInstanceType" : "hbase.sn1.large",
      "ClusterName" : "test",
      "MasterDiskType" : "cloud_efficiency",
      "Engine" : "hbase",
      "CoreDiskCount" : 2,
      "ParentId" : "2980****2123",
      "MajorVersion" : 2,
      "Status" : "ACTIVATION",
      "ExpireTimeUTC" : "2019-10-12T14:40:46Z",
      "MasterDiskSize" : 100,
      "ZoneId" : "cn-hangzhou-f",
      "ClusterId" : "hb-bp1u0639js2h7****",
      "CoreNodeCount" : 2,
      "InstanceId" : "hb-bp1u0639js2h7****",
      "ColdStorageStatus" : "open",
      "CreatedTimeUTC" : "2019-09-12T14:40:46Z",
      "Duration" : 12,
      "ClusterType" : "cluster",
      "PayType" : "Prepaid",
      "VswitchId" : "vsw-bp191ipotq****dbqf",
      "MasterNodeCount" : 2,
      "InstanceName" : "test",
      "AutoRenewal" : false,
      "VpcId" : "vpc-bp120k6ixs4eoghz****",
      "CoreDiskType" : "cloud_efficiency",
      "RegionId" : "cn-hangzhou",
      "ExpireTime" : "2019-10-12T14:40:46",
      "BackupStatus" : "open",
      "CoreDiskSize" : 100
    }, {
      "Tags" : {
        "Tag" : {
          "Value" : "test-value",
          "Key" : "test-key"
        }
      }
    } ]
  },
  "TotalCount" : 18,
  "PageSize" : 10,
  "RequestId" : "EBECBF12-2E34-41BE-8DE9-FC3700D4****",
  "PageNumber" : 1
}

Error codes

For a list of error codes, see Service error codes.