调用DescribeInstances查询指定地域的HBase实例列表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstances

系统规定参数。取值:DescribeInstances

RegionId String cn-hangzhou

实例所属的地域ID。

说明 调用本接口时,如果传入了Tag.N.KeyTag.N.Value参数,则本参数必须传入。
PageNumber Integer 1

实例列表的页码,起始值为1,默认值为1

PageSize Integer 10

每页最多可显示的行数,最大值为100,默认值为10

DbType String hbase

服务类型,取值:

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

标签的键,与Tag Value组成标签的键值对,格式为{"key1":"value1","key2":"value2"}。

Tag.N.Value String value

标签键的值,与Tag Key组成标签的键值对。

ClusterName String test

HBase实例名称。

ResourceGroupId String rg-4f51d54g5****

资源组ID,可通过资源组控制台查询。

返回数据

名称 类型 示例值 描述
Instances Array of Instance

HBase实例列表信息。

Instance
AutoRenewal Boolean false

实例是否自动续费。返回值:

  • true:自动续费。
  • false:手动续费。
说明 仅当实例的付费类型为包年包月才会返回本参数。
BackupStatus String open

表示是否支持备份功能,返回值:

  • open:支持备份功能。
  • close:不支持备份功能。
ClusterId String hb-bp16f1441y6p2****

实例ID。

ClusterName String openapi-test

实例名称。

ClusterType String cluster

实例类型,返回值:

  • cluster:集群版。
  • single:单节点。
ColdStorageStatus String open

是否支持冷存储功能,返回值:

  • open:支持冷存储功能。
  • close:不支持冷存储功能。
CoreDiskCount String 2

Core磁盘数量。

CoreDiskSize Integer 100

Core节点磁盘容量,默认单位G。

CoreDiskType String cloud_efficiency

Core节点磁盘类型,返回值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • local_hdd:本地HDD盘。
  • local__ssd:本地SSD盘。
CoreInstanceType String hbase.sn1.large

Core节点规格。

CoreNodeCount Integer 2

Core节点个数。

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

实例创建时间。

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

实例创建时间,UTC格式。

Duration Integer 12

自动续费周期,返回值:

  • 按月购买:则自动续费周期为1个月。
  • 按年购买:则自动续费周期为1年(12个月)。
说明 仅当实例的付费类型为包年包月才会返回本参数。
Engine String hbase

数据引擎类型,返回值:

  • hbase:HBase标准版或HBase单机版。
  • hbaseue:HBase增强版。
  • serverlesshbase:HBaseServerless版。
  • bds:表示BDS实例。
ExpireTime String 2019-10-12T14:40:46

实例到期时间。

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

实例到期时间,UTC格式。

InstanceId String hb-bp16f1441y6p2****

实例ID。

InstanceName String openapi-test

实例名称。

IsDeletionProtection Boolean true

是否开启删除保护,返回值:

  • true:已开启。
  • false:未开启。
IsHa Boolean true

实例是否配置为高可用,返回值:

  • true:配置为高可用。
  • false:未配置为高可用。
说明
  • 集群版默认配置为高可用,使用2个Master节点。
  • 单节点配置为实际可用容量。
MajorVersion String 2.0

主版本号。

MasterDiskSize Integer 100

Master节点的磁盘容量,默认单位G。

MasterDiskType String cloud_efficiency

Master节点的磁盘类型,返回值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
说明 单节点实例会返回此参数。
MasterInstanceType String hbase.sn1.large

Master节点规格。

MasterNodeCount Integer 2

表示Master节点类型,返回值:

  • 0表示Master节点为单节点。
  • 2表示Master节点为集群版。
ModuleId Integer 0

模块ID。

ModuleStackVersion String 1.0

模块类型版本。

NetworkType String VPC

网络类型,返回值:

  • VPC:专有网络类型,如果为专有网络,就会返回VswitchId和VpcId参数。
  • CLASSIC:经典网络类型。
ParentId String 2980****2123

父实例ID。

PayType String Prepaid

实例的计费类型,返回值:

  • Prepaid:包年包月。
  • Postpaid:按量付费。
RegionId String cn-shanghai

实例所属地域ID。

ResourceGroupId String rg-4f51d54g5****

资源组ID。

Status String ACTIVATION

实例状态,返回值:

  • CREATING:创建中。
  • ACTIVATION:运行中。
  • DELETING:删除中。
  • RESTARTING:重启中。
  • MINOR_VERSION_TRANSING:小版本升级中。
Tags Array of Tag

资源标签。

Tag
Key String test-key

标签键

Value String test-value

标签值

VpcId String vpc-bp120k6ixs4eoghz*****

专有网络ID,当NetworkType2时会返回此参数。

VswitchId String vsw-bp191ipotq****dbqf

虚拟交换机ID,当NetworkType2时会返回此参数。

ZoneId String cn-hangzhou-f

可用区ID。

PageNumber Integer 1

实例列表的页码。

PageSize Integer 10

每页最多可显示的行数。

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

请求ID。

TotalCount Long 18

实例总个数。

示例

请求示例

http(s)://hbase.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

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>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格式

{
    "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
}

错误码

访问错误中心查看更多错误码。