查询集群列表

project_id

是

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及

tags

否

String

参数解释：

标签列表。可以通过集群的标签来搜索指定标签的集群，当指定多个tag进行查询时，标签之间是与的关系。

约束限制：

不涉及

取值范围：

• tags参数的格式为tags=k1*v1,k2*v2,k3*v3

• 当标签的value为空时，格式为tags=k1,k2,k3*v3

默认取值：

不涉及

pageSize

否

String

参数解释：

分页查询每页返回的最大集群数量。

约束限制：

不涉及

取值范围：

1-2147483646

默认取值：

10

currentPage

否

String

参数解释：

当前查询页码。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

1

clusterName

否

String

参数解释：

集群名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

clusterState

否

String

参数解释：

根据集群状态查询集群列表。

约束限制：

不涉及

取值范围：

• existing：查询现有集群列表，包括除“已删除”、包周期集群的“订单处理中”和“准备中”状态外的所有集群。

• history：查询历史集群列表，包括所有“已删除”、删除集群失败、集群删除虚拟机失败、删除集群更新数据库失败等状态的集群。

• starting：查询启动中的集群列表。

• running：查询运行中的集群列表。

• terminated：查询已删除的集群列表。

• failed：查询失败的集群列表。

• abnormal：查询异常的集群列表。

• terminating：查询删除中的集群列表。

• frozen：查询已冻结的集群列表。

• scaling-out：查询扩容中的集群列表。

• scaling-in：查询缩容中的集群列表。

默认取值：

不涉及

enterpriseProjectId

否

String

参数解释：

通过企业项目ID来搜索指定项目的集群。获取方式请参见《企业管理API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

0

clusterTotal

Integer

参数解释：

集群列表总数。

取值范围：

不涉及

clusters

Array of Cluster objects

参数解释：

集群参数。

clusterId

String

参数解释：

集群ID。

取值范围：

不涉及

clusterName

String

参数解释：

集群名称。

取值范围：

不涉及

totalNodeNum

String

参数解释：

集群部署的节点总数。

取值范围：

不涉及

clusterState

String

参数解释：

集群状态（默认为英文，当X-Language请求头被设置为zh-cn，该字段会返回中文，因此请谨慎设置X-Language等语言请求头）。

取值范围：

• starting：启动中。

• running：运行中。

• terminated：已删除。

• failed：失败。

• abnormal：异常。

• terminating：删除中。

• frozen：已冻结。

• scaling-out：扩容中。

• scaling-in：缩容中。

stageDesc

String

参数解释：

集群进度描述。（默认为英文，当X-Language请求头被设置为zh-cn时，该字段会返回中文，因此请谨慎设置X-Language等语言请求头）。

取值范围：

安装集群进度包括：

• Verifying cluster parameters：校验集群参数中

• Applying for cluster resources：申请集群资源中

• Creating VM：创建虚拟机中

• Initializing VM：初始化虚拟机中

• Installing MRS Manager：安装MRS Manager中

• Deploying cluster：部署集群中

• Cluster installation failed：集群安装失败

扩容集群进度包括：

• Preparing for cluster expansion：准备扩容中

• Creating VM：创建虚拟机中

• Initializing VM：初始化虚拟机中

• Adding node to the cluster：节点加入集群中

• Cluster expansion failed：集群扩容失败

缩容集群进度包括：

• Preparing for cluster shrink：正在准备缩容

• Decommissioning instance：实例退服中

• Deleting VM：删除虚拟机中

• Deleting node from the cluster：从集群删除节点中

• Cluster shrink failed：集群缩容失败

集群安装、扩容、缩容失败，stageDesc会显示失败的原因。

createAt

String

参数解释：

集群创建时间，十位时间戳。

取值范围：

不涉及

updateAt

String

参数解释：

集群更新时间，十位时间戳。

取值范围：

不涉及

chargingStartTime

String

参数解释：

开始计费时间。

取值范围：

不涉及

billingType

String

参数解释：

集群计费模式。

取值范围：

• 包周期计费

• 按需计费

dataCenter

String

参数解释：

集群工作区域。

取值范围：

不涉及

vpc

String

参数解释：

VPC名称。

取值范围：

不涉及

vpcId

String

参数解释：

VPC ID。

取值范围：

不涉及

duration

String

参数解释：

集群购买时长。

取值范围：

不涉及

fee

String

参数解释：

创建集群所需费用，系统自动计算。

取值范围：

不涉及

hadoopVersion

String

参数解释：

Hadoop组件版本信息。

取值范围：

不涉及

componentList

Array of ComponentAmb objects

参数解释：

组件列表信息。

externalIp

String

参数解释：

公网IP地址。用于集群外访问集群主master进程所开放IP的地址。

取值范围：

不涉及

externalAlternateIp

String

参数解释：

公网备用IP地址。用于集群外访问集群备master进程所使用的IP地址。

取值范围：

不涉及

internalIp

String

参数解释：

内网IP地址。用于集群内访问集群master进程所使用IP的地址。

取值范围：

不涉及

deploymentId

String

参数解释：

集群部署ID。本集群的任务部署所对应的ID，用于云服务查询集群部署任务详情。

取值范围：

不涉及

remark

String

参数解释：

集群备注信息。当前默认都为空。

取值范围：

不涉及

orderId

String

参数解释：

创建集群的订单号。

取值范围：

不涉及

azId

String

参数解释：

可用区域ID。

取值范围：

不涉及

azName

String

参数解释：

可用区域名称。

取值范围：

不涉及

azCode

String

参数解释：

可用区域英文名称。

取值范围：

不涉及

availabilityZoneId

String

参数解释：

可用区域。

取值范围：

不涉及

instanceId

String

参数解释：

实例ID。

取值范围：

不涉及

vnc

String

参数解释：

远程登录弹性云服务器的URI地址。

取值范围：

不涉及

tenantId

String

参数解释：

项目编号。

取值范围：

不涉及

volumeSize

Integer

参数解释：

磁盘存储空间。

取值范围：

不涉及

volumeType

String

参数解释：

磁盘类型。

取值范围：

不涉及

subnetId

String

参数解释：

子网ID。

取值范围：

不涉及

subnetName

String

参数解释：

子网名称。

取值范围：

不涉及

securityGroupsId

String

参数解释：

安全组ID。

取值范围：

不涉及

slaveSecurityGroupsId

String

参数解释：

非Master节点的安全组id，当前一个MRS集群只会使用一个安全组，所以该字段已经废弃，从兼容性考虑，该字段会返回和securityGroupsId同样的值。

取值范围：

不涉及

bootstrapScripts

Array of BootstrapScript objects

参数解释：

配置引导操作脚本信息。

safeMode

Integer

参数解释：

MRS集群运行模式。

取值范围：

• 0：普通集群

• 1：安全集群

clusterVersion

String

参数解释：

集群版本。

取值范围：

不涉及

nodePublicCertName

String

参数解释：

密钥文件名称。

取值范围：

不涉及

masterNodeIp

String

参数解释：

Master节点IP。

取值范围：

不涉及

privateIpFirst

String

参数解释：

首选私有IP。

取值范围：

不涉及

errorInfo

String

参数解释：

错误信息。

取值范围：

不涉及

tags

String

参数解释：

标签信息。

取值范围：

不涉及

masterNodeNum

String

参数解释：

集群部署的Master节点数量。

取值范围：

不涉及

coreNodeNum

String

参数解释：

集群部署的Core节点数量。

取值范围：

不涉及

masterNodeSize

String

参数解释：

Master节点的实例规格。

取值范围：

不涉及

coreNodeSize

String

参数解释：

Core节点的实例规格。

取值范围：

不涉及

masterNodeProductId

String

参数解释：

Master节点产品ID。

取值范围：

不涉及

masterNodeSpecId

String

参数解释：

Master节点规格ID。

取值范围：

不涉及

coreNodeProductId

String

参数解释：

Core节点产品ID。

取值范围：

不涉及

coreNodeSpecId

String

参数解释：

Core节点规格ID。

取值范围：

不涉及

masterDataVolumeType

String

参数解释：

Master节点数据磁盘存储类别，目前支持SATA、SAS和SSD。

取值范围：

不涉及

masterDataVolumeSize

Integer

参数解释：

Master节点数据磁盘存储空间。为增大数据存储容量，创建集群时可同时添加磁盘。单位为GB。

取值范围：

100-32000

masterDataVolumeCount

Integer

参数解释：

Master节点数据磁盘个数。

取值范围：

只能为1。

coreDataVolumeType

String

参数解释：

Core节点数据磁盘存储类别，目前支持SATA、SAS和SSD。

取值范围：

不涉及

coreDataVolumeSize

Integer

参数解释：

Core节点数据磁盘存储空间。为增大数据存储容量，创建集群时可同时添加磁盘。单位为GB。

取值范围：

100-32000

coreDataVolumeCount

Integer

参数解释：

Core节点数据磁盘个数。

取值范围：

1-10

enterpriseProjectId

String

参数解释：

企业项目ID。

取值范围：

不涉及

isMrsManagerFinish

Boolean

参数解释：

表示集群创建过程中，MRS Manager是否安装完成。

取值范围：

• true：安装完成。

• false：安装未完成。

clusterType

Integer

参数解释：

集群类型。

取值范围：

• 0：分析集群。

• 1：流式集群。

• 2：混合集群。

• 3：自定义集群。

• 4：离线集群。

logCollection

Integer

参数解释：

集群安装失败时，是否搜集日志。

取值范围：

• 0：不收集。

• 1：收集。

periodType

Integer

参数解释：

区分包周期，集群是包年还是包月。

取值范围：

• 0：包月。

• 1：包年。

scale

String

参数解释：

集群节点的变更状态（扩容/缩容/变更规格）。当该参数取值为空时，表示集群节点没有进行变更操作。（默认为英文，当X-Language请求头被设置为zh-cn时，该字段会返回中文，因此请谨慎设置X-Language等语言请求头）。

取值范围：

• scaling-out：扩容中。

• scaling-in：缩容中。

• scaling-error：处于running状态，且上一次扩容/缩容/升级规格失败的集群。

• scaling-up：Master节点规格升级中。

• scaling_up_first：备Master节点规格升级中。

• scaled_up_first：备Master节点规格升级成功。

• scaled-up-success：Master节点规格升级成功。

nodeGroups

Array of NodeGroupV10 objects

参数解释：

Master节点、Core节点和Task节点列表信息。

taskNodeGroups

Array of NodeGroupV10 objects

参数解释：

Task节点列表信息。

eipId

String

参数解释：

集群弹性公网ip的唯一标识。

取值范围：

不涉及

eipAddress

String

参数解释：

集群弹性公网ip的IPV4地址。

取值范围：

不涉及

eipv6Address

String

参数解释：

集群弹性公网ip的IPV6地址，IPv4时无此字段。

取值范围：

不涉及

componentId

String

参数解释：

组件ID。

取值范围：

不涉及

componentName

String

参数解释：

组件名称。

取值范围：

不涉及

componentVersion

String

参数解释：

组件版本。

取值范围：

不涉及

componentDesc

String

参数解释：

组件描述信息。

取值范围：

不涉及

name

String

参数解释：

引导操作脚本的名称。

约束限制：

不涉及

取值范围：

同一个集群的引导操作脚本名称不允许相同。不能以空格开头，只能由英文字母、数字以及“_”和“-”组成，且长度为[1-64]个字符。

默认取值：

不涉及

uri

String

参数解释：

引导操作脚本的路径。设置为OBS桶的路径或虚拟机本地的路径。

• OBS桶的路径：直接手动输入脚本路径。例如输入MRS提供的公共样例脚本路径。示例：s3a://bootstrap/presto/presto-install.sh，其中安装dualroles时，presto-install.sh脚本参数为dualroles,安装worker时，presto-install.sh脚本参数为worker。根据Presto使用习惯，建议您在Active Master节点上安装dualroles，在Core节点上安装worker。

• 虚拟机本地的路径：用户需要输入正确的脚本路径。脚本所在的路径必须以‘/’开头，以.sh结尾。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

parameters

String

参数解释：

引导操作脚本参数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

nodes

Array of strings

参数解释：

引导操作脚本所执行的节点类型，包含master、core和task三种类型。

约束限制：

节点类型必须为小写字母。

active_master

Boolean

参数解释：

引导操作脚本是否只运行在主Master节点上。

约束限制：

不涉及

取值范围：

• true：引导操作脚本只运行在主Master节点上。

• false：引导操作脚本可运行在所有Master节点上。

默认取值：

false

fail_action

String

参数解释：

引导操作脚本执行失败后，是否继续执行后续脚本和创建集群。建议您在调试阶段设置为“continue”，无论此引导操作是否执行成功，则集群都能继续安装和启动。

约束限制：

不涉及

取值范围：

• continue：继续执行后续脚本。

• errorout：终止操作。

默认取值：

continue

before_component_start

Boolean

参数解释：

引导操作脚本执行的时间。目前支持“组件启动前”和“组件启动后”两种类型。

约束限制：

不涉及

取值范围：

• true：引导操作脚本在组件启动前执行。

• false：引导操作脚本在组件启动后执行。

默认取值：

false

start_time

Long

参数解释：

单个引导操作脚本的执行时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

state

String

参数解释：

单个引导操作脚本的运行状态。

约束限制：

不涉及

取值范围：

• PENDING：挂起

• IN_PROGRESS：正在处理

• SUCCESS：处理成功

• FAILURE：处理失败

默认取值：

不涉及

action_stages

Array of strings

参数解释：

选择引导操作脚本执行的时间。

• BEFORE_COMPONENT_FIRST_START: 组件首次启动后

• AFTER_COMPONENT_FIRST_START: 组件首次启动前

• BEFORE_SCALE_IN: 缩容前

• AFTER_SCALE_IN: 缩容后

• BEFORE_SCALE_OUT: 扩容前

• AFTER_SCALE_OUT: 扩容后

约束限制：

不涉及

GroupName

String

参数解释：

节点组名。

取值范围：

不涉及

NodeNum

Integer

参数解释：

节点数量，取值范围0-500，Master节点和Core节点数量至少为1，Core与Task节点总数最大为500个。

取值范围：

0-500

NodeSize

String

参数解释：

节点的实例规格。

取值范围：

不涉及

NodeSpecId

String

参数解释：

节点实例规格ID。

取值范围：

不涉及

VmProductId

String

参数解释：

节点虚拟机产品ID。

取值范围：

不涉及

VmSpecCode

String

参数解释：

节点虚拟机产品规格。

取值范围：

不涉及

NodeProductId

String

参数解释：

节点实例产品ID。

取值范围：

不涉及

RootVolumeSize

Integer

参数解释：

节点系统盘大小，不可配置，默认为40GB。

取值范围：

不涉及

RootVolumeProductId

String

参数解释：

节点系统盘的产品ID。

取值范围：

不涉及

RootVolumeType

String

参数解释：

节点系统盘的类型。

取值范围：

不涉及

RootVolumeResourceSpecCode

String

参数解释：

节点系统盘产品规格。

取值范围：

不涉及

RootVolumeResourceType

String

参数解释：

节点系统盘产品类型。

取值范围：

不涉及

DataVolumeType

String

参数解释：

节点数据磁盘存储类别，目前支持SATA、SAS和SSD。

取值范围：

• SATA：普通IO

• SAS：高IO

• SSD：超高IO

DataVolumeCount

Integer

参数解释：

节点数据磁盘存储数目。

取值范围：

不涉及

DataVolumeSize

Integer

参数解释：

节点数据磁盘存储大小。

取值范围：

不涉及

DataVolumeProductId

String

参数解释：

节点数据磁盘的产品ID。

取值范围：

不涉及

DataVolumeResourceSpecCode

String

参数解释：

节点数据磁盘的产品规格。

取值范围：

不涉及

DataVolumeResourceType

String

参数解释：

节点数据磁盘的产品类型。

取值范围：

不涉及

200

查询集群列表信息成功。