Queries the details of one or more instances 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
Action String Yes DescribeInstances

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

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the latest available regions.

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.

  • The maximum value is 100.
  • The default value is 10.
DbType String No hbase

The type of the service. Valid values:

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

The key of custom tag N.

Tag.N.Value String No value

The value of custom tag N.

ClusterName String No test

The name of the 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

The list of instances.

Instance
AutoRenewal Boolean false

Indicates whether auto-renewal is enabled. Valid values: true and false.

Note If the pay-as-you-go billing method is used for your instance, this response parameter is not returned.
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.
ClusterId String hb-bp16f1441y6p2****

The ID of the instance. The ID is a unique identifier generated by the system. The value of this parameter is the same as that of the InstanceId parameter. We recommend that you use the value of the ClusterId parameter.

ClusterName String openapi-test

The name of the instance. The value of this parameter is the same as that of the InstanceName parameter. The value of the ClusterName parameter is preferred.

ClusterType String cluster

The type of the instance.

  • cluster
  • single
ColdStorageStatus String open

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

  • open: The page for cold and hot data separation is available.
  • close: The page for cold and hot data separation is unavailable.
CoreDiskCount String 2

The number of disks for the core node.

CoreDiskSize Integer 100

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

The disk type of the core node. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard 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 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 period.

  • Monthly subscription: The auto-renewal period is one month.
  • Annual subscription: The auto-renewal period is 1 year that is equal to 12 months.
Note If the pay-as-you-go billing method is used for your instance, this response parameter is not returned.
Engine String hbase

The engine type.

  • hbase
  • spark
  • geomesa
ExpireTime String 2019-10-12T14:40:46

The time when the instance expires.
ExpireTimeUTC String 2019-10-12T14:40:46Z

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

InstanceId String hb-bp16f1441y6p2****

The ID of the instance. The ID is a unique identifier generated by the system. The value of this parameter is the same as that of the ClusterId parameter. We recommend that you use the value of the ClusterId parameter.

InstanceName String openapi-test

The name of the instance. The returned name is the name that you specified based on your requirements. We recommend that you use the value of the ClusterName parameter.

IsDeletionProtection Boolean true

Indicates whether deletion protection is enabled.

IsHa Boolean true

Indicates whether the instance is a high-availability instance.

  • true: The instance is a high-availability instance.
  • false: The instance is not a high-availability 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: ultra disk
  • cloud_ssd: standard SSD
MasterInstanceType String hbase.sn1.large

The instance type of the master node.

MasterNodeCount Integer 2

If the instance is a single-node instance, the single node serves as the master node and the core node. In this case, the value 0 is returned for this parameter. If the instance is deployed in high-availability mode, the value 2 is returned for this parameter.

ModuleId Integer 0

The ID of the module.

ModuleStackVersion String 1.0

The version of the module stack.

NetworkType String VPC

The type of the network. Valid values:

  • VPC: the virtual private cloud (VPC) type.

  • CLASSIC: the classic network.

    If the network type is VPC, the values of the vSwitchId and VpcId parameters are also returned.

ParentId String 2980****2123

The ID of the parent node.

PayType String Prepaid

The billing method of the instance. Valid values:

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

The ID of the region where the instance is deployed.

ResourceGroupId String rg-xxxxxxxxxxxxx

The ID of the resource group to which the instance resources belong.

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

The tag information.
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.

VswitchId String vsw-bp191ipotq****dbqf

The ID of the vSwitch.

ZoneId String cn-hangzhou-f

The ID of the zone where the instance is deployed.

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. The ID is a unique identifier automatically generated for the request.

TotalCount Long 18

The total number of entries returned.

Examples

Sample requests

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

Sample success responses

XML format 

<Instances>
    <Instance>
        <ModuleStackVersion>1.0</ModuleStackVersion>
        <IsHa>true</IsHa>
        <CreatedTime>2019-09-12T14:40:46</CreatedTime>
        <ResourceGroupId>rg-xxxxxxxxxxxxx</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>

JSON format 

{
    "Instances": {
        "Instance": [
            {
                "ModuleStackVersion": 1,
                "IsHa": true,
                "CreatedTime": "2019-09-12T14:40:46",
                "ResourceGroupId": "rg-xxxxxxxxxxxxx",
                "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.