5.5 委托管理
6.1.3 查询集群列表
响应示例
状态码： 200
扩容/缩容集群Core节点或者Task节点成功。
{ "result" : "succeeded"
}
状态码
状态码 描述
200 扩容/缩容集群Core节点或者Task节点成功。
错误码
请参见错误码。
6.1.3 查询集群列表
功能介绍
查看用户创建的集群列表信息。该接口不兼容Sahara。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
GET /v1.1/{project_id}/cluster_infos
表6-20 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目编号。获取方法，请参见获 取项目ID。
表6-21 Query 参数
参数 是否必选 参数类型 描述
tags 否 String 可以通过集群的标签来搜索指定
标签的集群，当指定多个tag进 行查询时，标签之间是与的关 系。
● tags参数的格式为 tags=k1*v1,k2*v2,k3*v3
● 当标签的value为空时，格式 为tags=k1,k2,k3*v3
pageSize 否 String 分页查询每页返回的最大集群数
量。
取值范围：[1～2147483646]
currentPage 否 String 当前查询页码。
clusterName 否 String 集群名称。
参数 是否必选 参数类型 描述
clusterState 否 String 根据集群状态查询集群列表。
● existing：查询现有集群列 表，包括除“已删除”、包 周期集群的“订单处理中”
和“准备中”状态外的所有 集群。
● history：查询历史集群列 表，包括所有“已删除”、
删除集群失败、集群删除虚 拟机失败、删除集群更新数 据库失败等状态的集群。
● starting：查询启动中的集群 列表。
● running：查询运行中的集群 列表。
● terminated：查询已删除的 集群列表。
● failed：查询失败的集群列 表。
● abnormal：查询异常的集群 列表。
● terminating：查询删除中的 集群列表。
● frozen：查询已冻结的集群 列表。
● scaling-out：查询扩容中的 集群列表。
● scaling-in：查询缩容中的集 群列表。
enterpriseProj
ectId 否 String 通过企业项目ID来搜索指定项目
的集群。
该参数默认设置为0，表示为 default企业项目。
获取方式请参见《企业管理API 参考》的“查询企业项目列表”
响应消息表
“enterprise_project字段数据 结构说明”的“id”。
请求参数
无
响应参数
状态码： 200
表6-22 响应 Body 参数
参数 参数类型 描述
clusterTotal Integer 集群列表总数。
clusters Array of Cluster objects
集群参数。
表6-23 Cluster
参数 参数类型 描述
clusterId String 集群ID。
clusterName String 集群名称。
totalNodeNu
m String 集群部署的节点总数。
clusterState String 集群状态，包括：
● starting：启动中的集群。
● running：运行中的集群。
● terminated：已删除的集群。
● failed：失败的集群。
● abnormal：异常的集群。
● terminating：删除中的集群。
● frozen：已冻结的集群。
● scaling-out：扩容中的集群。
● scaling-in：缩容中的集群。
参数 参数类型 描述
stageDesc String 集群进度描述。
安装集群进度包括：
● 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 集群更新时间，十位时间戳。
chargingStart
Time String 开始计费时间。
billingType String 集群计费模式。
dataCenter String 集群工作区域。
vpc String VPC名称。
vpcId String VPC ID。
duration String 集群购买时长。
fee String 创建集群所需费用，系统自动计算。
参数 参数类型 描述 hadoopVersio
n String Hadoop组件版本信息。
componentLis
t Array of ComponentA mb objects
组件列表信息。
externalIp String 公网IP地址。
externalAltern
ateIp String 公网备用IP地址。
internalIp String 内网IP地址。
deploymentId String 集群部署ID。
remark String 集群备注信息。
orderId String 创建集群的订单号。
azId String 可用区域ID。
azName String 可用区域名称。
azCode String 可用区域英文名称 instanceId String 实例ID。
vnc String 远程登录弹性云服务器的URI地址。
tenantId String 项目编号。
volumeSize Integer 磁盘存储空间。
volumeType String 磁盘类型。
subnetId String 子网ID。
subnetName String 子网名称。
securityGroup
sId String 安全组ID。
slaveSecurity
GroupsId String 非Master节点的安全组id，当前一个MRS集群只 会使用一个安全组，所以该字段已经废弃，从兼 容性考虑，该字段会返回和securityGroupsId同样 的值。
bootstrapScri
pts Array of bootstrapScri ptResp objects
配置引导操作脚本信息。
safeMode Integer MRS集群运行模式。
● 0：普通集群
● 1：安全集群
参数 参数类型 描述 clusterVersion String 集群版本。
nodePublicCer
tName String 密钥文件名称。
masterNodeIp String Master节点IP。
privateIpFirst String 首选私有IP。
errorInfo String 错误信息。
tags String 标签信息
masterNodeN
um String 集群部署的Master节点数量。
coreNodeNu
m String 集群部署的Core节点数量。
masterNodeSi
ze String Master节点的实例规格。
coreNodeSize String Core节点的实例规格。
masterNodePr
oductId String Master节点产品ID。
masterNodeS
pecId String Master节点规格ID。
coreNodeProd
uctId String Core节点产品ID。
coreNodeSpec
Id String Core节点规格ID。
masterDataVo
lumeType String Master节点数据磁盘存储类别，目前支持SATA、
SAS和SSD。
masterDataVo
lumeSize Integer Master节点数据磁盘存储空间。为增大数据存储 容量，创建集群时可同时添加磁盘。 取值范围：
100GB～32000GB，传值只需填数字，不需要带 单位GB。
masterDataVo
lumeCount Integer Master节点数据磁盘个数。 取值只能是1 coreDataVolu
meType String Core节点数据磁盘存储类别，目前支持SATA、
SAS和SSD。
coreDataVolu
meSize Integer Core节点数据磁盘存储空间。为增大数据存储容 量，创建集群时可同时添加磁盘。 取值范围：
100GB～32000GB，传值只需填数字，不需要带 单位GB。
参数 参数类型 描述 coreDataVolu
meCount Integer Core节点数据磁盘个数。 取值范围：1～10 enterpriseProj
ectId String 企业项目ID。
isMrsManager
Finish Boolean 表示集群创建过程中，MRS Manager是否安装完 成。
● true：安装完成
● false：安装未完成 clusterType Integer 集群类型。
logCollection Integer 集群安装失败时，是否搜集日志。
● 0：不收集
● 1：收集
periodType Integer 区分包周期，集群是包年还是包月。
● 0：包月
● 1：包年
scale String 集群节点的变更状态（扩容/缩容/变更规格）。
当该参数取值为空时，表示集群节点没有进行变 更操作。 取值范围：
● 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
NodeGroupV 10 objects
Master节点、Core节点和Task节点列表信息。
taskNodeGro
ups Array of NodeGroupV 10 objects
Task节点列表信息。
表6-24 ComponentAmb
参数 参数类型 描述
componentId String 组件ID。
参数 参数类型 描述 componentNa
me String 组件名称。
componentVe
rsion String 组件版本。
componentDe
sc String 组件描述信息。
表6-25 bootstrapScriptResp
参数 参数类型 描述
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节点上。 缺 省值为false，表示引导操作脚本可运行在所有 Master节点上。
参数 参数类型 描述
fail_action String 引导操作脚本执行失败后，是否继续执行后续脚 本和创建集群。
缺省值为errorout，表示终止操作。
说明： 建议您在调试阶段设置为“继续”，无论 此引导操作是否执行成功，则集群都能继续安装 和启动。
枚举值：
● continue：继续执行后续脚本。
● errorout：终止操作。
before_compo
nent_start Boolean 引导操作脚本执行的时间。目前支持“组件启动 前”和“组件启动后”两种类型。 缺省值为 false，表示引导操作脚本在组件启动后执行。
start_time Long 单个引导操作脚本的执行时间。
state String 单个引导操作脚本的运行状态。
● PENDING
● IN_PROGRESS
● SUCCESS
● FAILURE
表6-26 NodeGroupV10
参数 参数类型 描述
groupName String 节点组名。
nodeNum Integer 节点数量，取值范围0～500，Master节点和Core 节点数量至少为1，Core与Task节点总数最大为 500个。
nodeSize String 节点的实例规格。
nodeSpecId String 节点实例规格ID。
vmProductId String 节点虚拟机产品ID。
vmSpecCode String 节点虚拟机产品规格。
nodeProductI
d String 节点实例产品ID。
rootVolumeSi
ze Integer 节点系统盘大小，不可配置，默认为40GB。
rootVolumePr
oductId String 节点系统盘的产品ID。
参数 参数类型 描述
String 节点系统盘产品规格。
rootVolumeRe
sourceType String 节点系统盘产品类型。
dataVolumeTy
pe String 节点数据磁盘存储类别，目前支持SATA、SAS和 SSD。
● SATA：普通IO
● SAS：高IO
● SSD：超高IO dataVolumeC
ount Integer 节点数据磁盘存储数目。
dataVolumeSi
ze Integer 节点数据磁盘存储大小。
dataVolumePr
oductId String 节点数据磁盘的产品ID。
dataVolumeR esourceSpecC ode
String 节点数据磁盘的产品规格。
dataVolumeR
esourceType String 节点数据磁盘的产品类型。
请求示例
GET /v1.1/{project_id}/cluster_infos?
pageSize={page_size}¤tPage={current_page}&clusterState={cluster_state}&tags={tags}
响应示例
状态码： 200
查询集群列表信息成功。
{ "clusterTotal" : "1", "clusters" : [ {
"clusterId" : "bc134369-294c-42b7-a707-b2036ba38524", "clusterName" : "mrs_D0zW",
"masterNodeNum" : "2", "coreNodeNum" : "3", "clusterState" : "terminated", "createAt" : "1498272043", "updateAt" : "1498636753", "chargingStartTime" : "1498273733", "log_collection" : "1",
"billingType" : "Metered", "dataCenter" : "cn-north-1", "vpc" : null,
"duration" : "0", "fee" : null,
"hadoopVersion" : null, "masterNodeSize" : null, "coreNodeSize" : null, "componentList" : [ {
"componentId" : "MRS 3.1.0_001", "componentName" : "Hadoop", "componentVersion" : "3.1.1",
"componentDesc" : "A framework that allows for the distributed processing of large data sets across clusters."
}, {
"componentId" : "MRS 3.1.0_003", "componentName" : "HBase", "componentVersion" : "2.1.1",
"componentDesc" : "A scalable, distributed database that supports structured data storage for large tables."
}, {
"componentId" : "MRS 3.1.0_002", "componentName" : "Spark", "componentVersion" : "2.3.2",
"componentDesc" : "A fast and general engine for large-scale data processing."
}, {
"componentId" : "MRS 3.1.0_004", "componentName" : "Hive", "componentVersion" : "3.1.0",
"componentDesc" : "A data warehouse infrastructure that provides data summarization and ad hoc querying."
} ],
"externalIp" : null, "externalAlternateIp" : null, "internalIp" : null,
"deploymentId" : null, "remark" : "", "orderId" : null, "azId" : null,
"masterNodeProductId" : null, "masterNodeSpecId" : null, "coreNodeProductId" : null, "coreNodeSpecId" : null, "azName" : "az1.dc1", "instanceId" : null,
"vnc" : "v2/5a3314075bfa49b9ae360f4ecd333695/servers/e2cda891-232e-4703-995e-3b1406add01d/
action", "securityGroupsId" : null, "slaveSecurityGroupsId" : null, "mrsManagerFinish" : "false",
"stageDesc" : "Installing MRS Manager", "safeMode" : "0",
"clusterVersion" : null, "nodePublicCertName" : null, "masterNodeIp" : "unknown", "privateIpFirst" : null, "errorInfo" : "", "clusterType" : "0", "nodeGroups" : [ {
"groupName" : "master_node_default_group", "nodeNum" : "1",
"nodeSize" : "s3.xlarge.2.linux.bigdata",
"nodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7", "vmProductId" : "",
"vmSpecCode" : null,
"nodeProductId" : "dc970349d128460e960a0c2b826c427c", "rootVolumeSize" : "40",
"rootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572", "rootVolumeType" : "SATA",
"rootVolumeResourceSpecCode" : "", "rootVolumeResourceType" : "", "dataVolumeType" : "SATA", "dataVolumeCount" : "1", "dataVolumeSize" : "100",
"dataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572", "dataVolumeResourceSpecCode" : "",
"dataVolumeResourceType" : ""
}, {
"groupName" : "core_node_analysis_group", "nodeNum" : "1",
"nodeSize" : "s3.xlarge.2.linux.bigdata",
"nodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7", "vmProductId" : "",
"vmSpecCode" : null,
"nodeProductId" : "dc970349d128460e960a0c2b826c427c", "rootVolumeSize" : "40",
"rootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572", "rootVolumeType" : "SATA",
"rootVolumeResourceSpecCode" : "", "rootVolumeResourceType" : "", "dataVolumeType" : "SATA", "dataVolumeCount" : "1", "dataVolumeSize" : "100",
"dataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572", "dataVolumeResourceSpecCode" : "",
"dataVolumeResourceType" : ""
}, {
"groupName" : "task_node_analysis_group", "nodeNum" : "1",
"nodeSize" : "s3.xlarge.2.linux.bigdata",
"nodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7", "vmProductId" : "",
"vmSpecCode" : null,
"nodeProductId" : "dc970349d128460e960a0c2b826c427c", "rootVolumeSize" : "40",
"rootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572", "rootVolumeType" : "SATA",
"rootVolumeResourceSpecCode" : "", "rootVolumeResourceType" : "", "dataVolumeType" : "SATA", "dataVolumeCount" : "1", "dataVolumeSize" : "100",
"dataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572", "dataVolumeResourceSpecCode" : "",
"dataVolumeResourceType" : ""
} ],
"taskNodeGroups" : [ {
"groupName" : "task_node_default_group", "nodeNum" : "1",
"nodeSize" : "s3.xlarge.2.linux.bigdata",
"nodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7", "vmProductId" : "",
"vmSpecCode" : null,
"nodeProductId" : "dc970349d128460e960a0c2b826c427c", "rootVolumeSize" : "40",
"rootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572", "rootVolumeType" : "SATA",
"rootVolumeResourceSpecCode" : "", "rootVolumeResourceType" : "", "dataVolumeType" : "SATA", "dataVolumeCount" : "1", "dataVolumeSize" : "100",
"dataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
"dataVolumeResourceSpecCode" : "", "dataVolumeResourceType" : ""
} ],
"masterDataVolumeType" : "SATA", "masterDataVolumeSize" : "200", "masterDataVolumeCount" : "1", "coreDataVolumeType" : "SATA", "coreDataVolumeSize" : "100", "coreDataVolumeCount" : "1", "periodType" : "0"
} ] }
状态码
状态码 描述
200 查询集群列表信息成功。
错误码
请参见错误码。