调用DescribeInstances接口分页获取集群列表信息。

调试

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

请求参数

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

系统规定参数。取值：DescribeInstances。
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

集群名称。
ResourceGroupId String 否 rg-4f51d54g5****

资源组Id，可通过资源组控制台查询。

返回数据

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

集群列表信息。
Instance
AutoRenewal Boolean false

是否自动续费。可取值：true/false

说明 后付费实例无此返回值
BackupStatus String open

备份恢复状态：

  • open：展示备份恢复。
  • close：不展示备份恢复。
ClusterId String hb-bp16f1441y6p2****

集群ID，系统生成的唯一标识码，等于InstanceId，首选ClusterId。
ClusterName String openapi-test

集群名称，等于InstanceName，首选ClusterName。
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云盘。
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
  • spark
  • geomesa
ExpireTime String 2019-10-12T14:40:46

失效时间
ExpireTimeUTC String 2019-10-12T14:40:46Z

失效时间，UTC格式。
InstanceId String hb-bp16f1441y6p2****

集群ID，系统生成的唯一标识码，等于ClusterId，建议统一使用ClusterId。
InstanceName String openapi-test

集群name，用户可自行设置，建议统一使用ClusterName。
IsDeletionProtection Boolean true

是否开启保护。
IsHa Boolean true

是否高可用

  • true：高可用。
  • false：非高可用。
MajorVersion String 2.0

主版本号。
MasterDiskSize Integer 100

主节点磁盘大小，默认单位G
MasterDiskType String cloud_efficiency

主节点磁盘类型

  • cloud_efficiency：高效云盘。
  • cloud_ssd：ssd云盘。
MasterInstanceType String hbase.sn1.large

主节点实例类型。
MasterNodeCount Integer 2

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

模块id。
ModuleStackVersion String 1.0

模块堆栈版本。
NetworkType String VPC

网络类型，

  • VPC：VPC网络类型。

  • CLASSIC：经典网络类型。

    如果为VPC, 就有vSwitchId, vpcId
ParentId String 2980****2123

父类id。
PayType String Prepaid

付费类型：

  • Prepaid：预付费。
  • Postpaid：后付费。
RegionId String cn-shanghai

实例所属地域ID。
ResourceGroupId String rg-xxxxxxxxxxxxx

资源所在的资源组Id。
Status String ACTIVATION

集群状态

  • CREATING创建中。
  • ACTIVATION运行中
  • DELETING删除中。
  • RESTARTING重启中。
Tags Array of Tag

标签
Tag
Key String test-key

标签键
Value String test-value

标签值
VpcId String vpc-bp120k6ixs4eoghz*****

专有网络vpcId。
VswitchId String vsw-bp191ipotq****dbqf

虚拟交换机id。
ZoneId String cn-hangzhou-f

实例所属可用区ID。
PageNumber Integer 1

实例列表的页码。
PageSize Integer 10

分页查询时设置的每页行数。
RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4****

request Id 自动生成的唯一请求标识码。
TotalCount Long 18

总记录数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<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-bp16f1441y6p2kv**</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格式 

{
    "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-bp16f1441y6p2kv**",
                "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
}

错误码

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