分页获取集群列表信息

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

PageNumber Integer 1

实例状态列表的页码。起始值:1。

默认值:1 。

PageSize Integer 10

分页查询时设置的每页行数。最大值:100。

默认值:10。

DbType String hbase

服务类型:hbase/spark/bds

Tag.N.Key String key

自定义标签key

Tag.N.Value String value

自定义标签value

ClusterName String test

集群名称

返回数据

名称 类型 示例值 描述
RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4D6**

request Id 自动生成的唯一请求标识码

TotalCount Long 18

总记录数

PageNumber Integer 1

实例列表的页码

PageSize Integer 10

分页查询时设置的每页行数

Instances Array

集群列表信息

InstanceId String hb-bp16f1441y6p2kv**

集群ID,系统生成的唯一标识码,等于ClusterId,建议统一使用ClusterId

InstanceName String openapi-test

集群name,用户可自行设置,建议统一使用ClusterName

Status String ACTIVATION

集群状态 CREATING创建中 ACTIVATION运行中 DELETING删除中 RESTARTING重启中...

PayType String Prepaid

付费类型:

  • Prepaid:预付费
  • Postpaid:后付费
CreatedTime String 2019-09-12T14:40:46

集群创建时间

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

失效时间

MajorVersion String 2.0

主版本号

Engine String hbase

产品引擎 hbase spark geomesa ...

IsHa Boolean true

是否高可用?true/false

NetworkType String VPC

网络类型, VPC VPC网络类型 CLASSIC 经典网络类型 如果为VPC, 就有vSwitchId, vpcId

VpcId String vpc-bp120k6ixs4eoghz*****

专有网络vpcId,NetworkType为2时会有,vpc-xxxx

VswitchId String vsw-bp191ipotq****dbqf

虚拟交换机id,NetworkType为2时会有,vsw-xxxx

MasterInstanceType String hbase.sn1.large

主节点实例类型

MasterNodeCount Integer 2

主节点个数 为单节点时既是master也是core,此时返回0 为ha高可用时是2

MasterDiskType String cloud_efficiency

主节点磁盘类型 cloud_efficiency 高效云盘 cloud_ssd ssd云盘

MasterDiskSize Integer 100

主节点磁盘大小,默认单位G

CoreInstanceType String hbase.sn1.large

core节点实例类型

CoreNodeCount Integer 2

core节点个数

CoreDiskType String cloud_efficiency

core节点磁盘类型 cloud_efficiency 高效云盘 cloud_ssd ssd云盘

CoreDiskSize Integer 100

core节点磁盘大小,默认单位G

RegionId String cn-shanghai

实例所属地域ID

ZoneId String cn-hangzhou-f

实例所属可用区ID

ColdStorageStatus String open

冷热分离状态:

open-有冷热分离页面

close-无冷热分离页面

BackupStatus String open

备份恢复状态:

open-展示备份恢复

close-不展示备份恢复

ClusterType String cluster

集群类型,cluster/single

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

集群创建时间,UTC格式。

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

失效时间,UTC格式。

ClusterId String hb-bp16f1441y6p2kv**

集群ID,系统生成的唯一标识码,等于InstanceId,首选ClusterId。

ClusterName String openapi-test

集群名称,等于InstanceName,首选ClusterName。

Tags Array

标签

Key String test-key

标签键

Value String test-value

标签值

示例

请求示例

http(s)://[Endpoint]/?<公共请求参数>

正常返回示例

XML 格式

<PageNumber>1</PageNumber>
<TotalCount>9</TotalCount>
<PageSize>10</PageSize>
<RequestId>4871E1AF-BAB2-41B6-B9D6-41717861F443</RequestId>
<Instances>
    <Instance>
        <ClusterId>hb-bp16o0pd52e3y582s</ClusterId>
        <ZoneId>cn-hangzhou-f</ZoneId>
        <MasterDiskSize>0</MasterDiskSize>
        <VpcId>vpc-bp120k6ixs4eoghzwvu6x</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-bp191ipotqj1ssyl7dbqf</VswitchId>
        <CoreDiskSize>100</CoreDiskSize>
        <PayType>PayAsYouGo</PayType>
        <ClusterName>wangjk-HBase</ClusterName>
        <MasterInstanceType>hbase.sn1.medium</MasterInstanceType>
        <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>
    </Instance>
    <Instance/>
</Instances>

JSON 格式

{
  "PageNumber": 1,
  "TotalCount": 9,
  "PageSize": 10,
  "RequestId": "4871E1AF-BAB2-41B6-B9D6-41717861F443",
  "Instances": {
    "Instance": [
      {
        "ClusterId": "hb-bp16o0pd52e3y582s",
        "ZoneId": "cn-hangzhou-f",
        "MasterDiskSize": 0,
        "VpcId": "vpc-bp120k6ixs4eoghzwvu6x",
        "Engine": "hbase",
        "MajorVersion": "2.0",
        "CoreNodeCount": 4,
        "NetworkType": "VPC",
        "CoreDiskType": "cloud_ssd",
        "MasterDiskType": "",
        "CoreInstanceType": "hbase.sn1.large",
        "VswitchId": "vsw-bp191ipotqj1ssyl7dbqf",
        "CoreDiskSize": 100,
        "PayType": "PayAsYouGo",
        "ClusterName": "wangjk-HBase",
        "MasterInstanceType": "hbase.sn1.medium",
        "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"
      },{
          
      }
    ]
  }
}

错误码

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