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

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 DescribeInstances

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

RegionId String Yes cn-hangzhou

The ID of the region where the instance is deployed.

Note If you specify the Tag.N.Key and Tag.N.Value parameters when you call this operation, you must specify the RegionId parameter.
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 service. Valid values:

  • hbase
  • spark
  • bds
Tag.N.Key String No key

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

Tag.N.Value String No value

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

ClusterName String No test

The name of the ApsaraDB for HBase instance.

ResourceGroupId String No rg-4f51d54g5****

The ID of the resource group. You can query the group ID in the resource group console.

Response parameters

Parameter Type Example Description
Instances Array of Instance

Detailed information about the ApsaraDB for HBase instances.

Instance
AutoRenewal Boolean false

Indicates whether auto-renewal is enabled. Valid values:

  • true: enabled
  • false: disabled
Note This parameter is returned only if the instance is a subscription instance.
BackupStatus String open

Indicates whether the backup feature is enabled.

  • open: The backup feature is enabled.
  • close: The backup feature is disabled.
ClusterId String hb-bp16f1441y6p2****

The ID of the instance.

ClusterName String openapi-test

The name of the instance.

ClusterType String cluster

The type of the instance. Valid values:

  • cluster: a cluster instance
  • single: a standalone instance
ColdStorageStatus String open

Indicates whether cold data storage is enabled. Valid values:

  • open: enabled
  • close: disabled
CoreDiskCount String 2

The number of disks of 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: ultra disk
  • cloud_ssd: standard SSD
  • local_hdd: local HDD
  • local__ssd: local SSD
CoreInstanceType String hbase.sn1.large

The type of the core node.

CoreNodeCount Integer 2

The number of core nodes.

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

The time when the instance was created.

CreatedTimeUTC String 2019-09-12T14:40:46Z

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

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.
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: Big DataHub Service (BDS) instance
ExpireTime String 2019-10-12T14:40:46

The expiration date of the instance.

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

The expiration date of the instance. The time is displayed in UTC.

InstanceId String hb-bp16f1441y6p2****

The ID of the instance.

InstanceName String openapi-test

The name of the instance.

IsDeletionProtection Boolean true

Indicates whether deletion protection is enabled. Valid values:

  • true: enabled
  • false: disabled
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 is created on two master nodes to ensure high availability.
  • If the instance is a standalone instance, the instance is created on one node. In this case, the storage capacity of the instance equals the storage capacity of the disk mounted to the node.
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: ultra disk
  • cloud_ssd: standard SSD
Note This parameter is returned only when a standalone instance is specified.
MasterInstanceType String hbase.sn1.large

The type of the master node.

MasterNodeCount Integer 2

Indicates the type of the master node. Valid values:

  • 0: indicates that a single master node is created.
  • 2: indicates that two master nodes are created.
ModuleId Integer 0

The ID of the module.

ModuleStackVersion String 1.0

The version of the module.

NetworkType String VPC

The network type of the instance. Valid values:

  • VPC: virtual private network (VPC). If the network type is set to VPC, VswitchId and a VpcId are returned.
  • CLASSIC: classic network.
ParentId String 2980****2123

The ID of the parent instance.

PayType String Prepaid

The billing method of the instance. Valid values:

  • Prepaid: subscription
  • Postpaid: pay-as-you-go
RegionId String cn-shanghai

The ID of the region where the instance is deployed.

ResourceGroupId String rg-4f51d54g5****

The ID of the resource group.

Status String ACTIVATION

The status 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.
Tags Array of Tag

The resource tags.

Tag
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. This parameter is returned only when NetworkType is set to 2.

VswitchId String vsw-bp191ipotq****dbqf

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

ZoneId String cn-hangzhou-f

The ID of the zone.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

TotalCount Long 18

The total number of instances returned.

Examples

Sample requests

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

Sample success responses

XML format

<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>openapi-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-bp16f1441y6p2****</ClusterId>
              <CoreNodeCount>2</CoreNodeCount>
              <InstanceId>hb-bp16f1441y6p2****</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>openapi-test</InstanceName>
              <AutoRenewal>false</AutoRenewal>
              <VpcId>vpc-bp120k6ixs4eoghz****</VpcId>
              <CoreDiskType>cloud_efficiency</CoreDiskType>
              <RegionId>cn-shanghai</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

{
    "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": "openapi-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-bp16f1441y6p2****",
                "CoreNodeCount": 2,
                "InstanceId": "hb-bp16f1441y6p2****",
                "ColdStorageStatus": "open",
                "CreatedTimeUTC": "2019-09-12T14:40:46Z",
                "Duration": 12,
                "ClusterType": "cluster",
                "PayType": "Prepaid",
                "VswitchId": "vsw-bp191ipotq****dbqf",
                "MasterNodeCount": 2,
                "InstanceName": "openapi-test",
                "AutoRenewal": false,
                "VpcId": "vpc-bp120k6ixs4eoghz****",
                "CoreDiskType": "cloud_efficiency",
                "RegionId": "cn-shanghai",
                "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, visit the API Error Center.