调用ListClusterHostGroup接口,查询集群机器组列表。

调试

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

请求参数

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

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求,该参数为必选参数。取值:ListClusterHostGroup。

ClusterId String C-D7958B72E59B****

集群ID。您可以调用ListClusters接口查看集群的ID。

RegionId String cn-hangzhou

区域ID。您可以调用DescribeRegions接口查看最新的阿里云地域列表。

HostGroupId String G-76D09CF110A3****

机器组ID。

HostGroupName String core_group

待查询的机器组名称。

HostGroupType String CORE

待查询的机器组类型:

  • MASTER:主实例组
  • CORE:核心实例组
  • TASK:计算实例组
StatusList.N RepeatList NORMAL

待查询的机器组状态列表:

  • NORMAL
  • ABNORMAL
  • DELETED
PageNumber Integer 1

当前页码,从1开始。

PageSize Integer 10

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

返回数据

名称 类型 示例值 描述
ClusterId String C-D7958B72E59B****

集群ID。

HostGroupList Array of HostGroup

集群的机器组信息列表。

HostGroup
ChargeType String PostPaid

当前机器组的付费方式:

  • PostPaid:按量付费集群
  • PrePaid:包年包月集群
Comment String 备注信息

机器组的备注信息。

CostSavingPercent Float 0

保留字段。

Cpu Integer 4

机器组中节点的CPU规格。

DataDiskCount Integer 4

机器组中节点的数据盘块数。

DataDiskSize Integer 100

机器组中节点的单块数据盘大小,单位GB。

DataDiskType String CLOUD_SSD

机器组中节点的数据盘类型。

HostGroupChangeStatus String IN_PROGRESS

升配任务的执行状态:

  • IN_PROGRESS:处理中
  • COMPLETED:已完成
  • FAILED:失败
HostGroupChangeType String RESIZE_DISK

机器组当前的操作类型:

  • RESIZE_DISK
  • MODIFY_INSTANCE_TYPE
  • RESTART_HOST_GROUP
HostGroupId String G-EBAA5D6566E7****

机器组ID。

HostGroupName String Core_Group

机器组名称。

HostGroupSubType String AutoScaling

机器组的子类型。例如AutoScaling。

HostGroupType String CORE

机器组类型:

  • MASTER:主实例节点
  • CORE:核心实例节点
  • TASK:计算实例节点
InstanceType String ecs.c5.xlarge

机器组的节点规格。

LockReason String Your account balance is insufficient

锁定原因。

LockType String ACCOUNTARREARS

机器组的锁定类:

  • CLUSTER_EXPIRED(集群过期)
  • ACCOUNT_ARREARS(账号欠费)
Memory Integer 8

机器组中节点的内存规格。

NodeCount Integer 3

机器组中节点的数量。

PayType String PostPaid

机器组的付费类型信息。

ScalingGroupActiveStatus String

保留字段。

ScalingGroupBizId String

保留字段。

ScalingGroupConfigState String

保留字段。

ScalingGroupMaxNode Integer 0

保留字段。

ScalingGroupMinNode Integer 0

保留字段。

ScalingInMode String

保留字段。

SecurityGroupId String sg-xxx

安全组ID。

Status String NORMAL

机器组状态。

SystemDiskCount Integer 1

机器组中节点的系统盘的块数。

SystemDiskSize Integer 40

机器组中节点的单块系统盘的大小,单位GB。

SystemDiskType String CLOUD_SSD

机器组中节点的系统盘类型。

VswitchId String vsw-bp1aij6ynkt53ntnf****

交换机ID。

gmtCreate String 1597042920000

创建时间。

gmtModified String 1597043525000

更新时间。

PageNumber Integer 1

当前页码。

PageSize Integer 100

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

RequestId String BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22

请求ID。

Total Integer 15

查询总数。

示例

请求示例

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

正常返回示例

XML 格式

<RequestId>9807D530-57B4-4BA7-93E8-E4F2B3826345</RequestId>
<PageSize>100</PageSize>
<PageNumber>1</PageNumber>
<HostGroupList>
    <HostGroup>
        <HostGroupType>CORE</HostGroupType>
        <Status>NORMAL</Status>
        <Comment/>
        <gmtModified>1597043525000</gmtModified>
        <NodeCount>2</NodeCount>
        <SystemDiskSize>120</SystemDiskSize>
        <Memory>8</Memory>
        <Cpu>4</Cpu>
        <DataDiskCount>4</DataDiskCount>
        <PayType>PostPaid</PayType>
        <HostGroupName>核心实例组</HostGroupName>
        <gmtCreate>1597042920000</gmtCreate>
        <VswitchId>vsw-bp1aij6ynkt53ntnffynb</VswitchId>
        <SystemDiskType>CLOUD_SSD</SystemDiskType>
        <HostGroupId>G-519D30DDF1D6B3E1</HostGroupId>
        <DataDiskType>CLOUD_SSD</DataDiskType>
        <ChargeType>PostPaid</ChargeType>
        <DataDiskSize>80</DataDiskSize>
        <InstanceType>ecs.n4.xlarge</InstanceType>
    </HostGroup>
    <HostGroup>
        <HostGroupType>MASTER</HostGroupType>
        <Status>NORMAL</Status>
        <Comment/>
        <gmtModified>1597043525000</gmtModified>
        <NodeCount>1</NodeCount>
        <SystemDiskSize>120</SystemDiskSize>
        <Memory>8</Memory>
        <Cpu>4</Cpu>
        <DataDiskCount>1</DataDiskCount>
        <PayType>PostPaid</PayType>
        <HostGroupName>主实例组</HostGroupName>
        <gmtCreate>1597042920000</gmtCreate>
        <VswitchId>vsw-bp1aij6ynkt53ntnffynb</VswitchId>
        <SystemDiskType>CLOUD_SSD</SystemDiskType>
        <HostGroupId>G-FFE7A21D570D050E</HostGroupId>
        <DataDiskType>CLOUD_SSD</DataDiskType>
        <ChargeType>PostPaid</ChargeType>
        <DataDiskSize>80</DataDiskSize>
        <InstanceType>ecs.n4.xlarge</InstanceType>
    </HostGroup>
</HostGroupList>

JSON 格式

{
	"RequestId": "9807D530-57B4-4BA7-93E8-E4F2B3826345",
	"PageSize": 100,
	"PageNumber": 1,
	"HostGroupList": {
		"HostGroup": [
			{
				"HostGroupType": "CORE",
				"Status": "NORMAL",
				"Comment": "",
				"gmtModified": 1597043525000,
				"NodeCount": 2,
				"SystemDiskSize": 120,
				"Memory": 8,
				"Cpu": 4,
				"DataDiskCount": 4,
				"PayType": "PostPaid",
				"HostGroupName": "核心实例组",
				"gmtCreate": 1597042920000,
				"VswitchId": "vsw-bp1aij6ynkt53ntnffynb",
				"SystemDiskType": "CLOUD_SSD",
				"HostGroupId": "G-519D30DDF1D6B3E1",
				"DataDiskType": "CLOUD_SSD",
				"ChargeType": "PostPaid",
				"DataDiskSize": 80,
				"InstanceType": "ecs.n4.xlarge"
			},
			{
				"HostGroupType": "MASTER",
				"Status": "NORMAL",
				"Comment": "",
				"gmtModified": 1597043525000,
				"NodeCount": 1,
				"SystemDiskSize": 120,
				"Memory": 8,
				"Cpu": 4,
				"DataDiskCount": 1,
				"PayType": "PostPaid",
				"HostGroupName": "主实例组",
				"gmtCreate": 1597042920000,
				"VswitchId": "vsw-bp1aij6ynkt53ntnffynb",
				"SystemDiskType": "CLOUD_SSD",
				"HostGroupId": "G-FFE7A21D570D050E",
				"DataDiskType": "CLOUD_SSD",
				"ChargeType": "PostPaid",
				"DataDiskSize": 80,
				"InstanceType": "ecs.n4.xlarge"
			}
		]
	}
}