集群管理API

CreateCluster 创建集群
请求参数

字段	类型	是否必须	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：CreateCluster
RegionId	String	是	-	地域ID
ZoneId	String	否	-	可用区ID
Name	String	是	-	集群名字。长度2-64字符，只允许包含中文、字母、数字、两种符号-和_ ，必须以字母或中文开头。
Description	String	否	空	集群描述，2~128个字符。
EhpcVersion	String	是	-	EHPC产品版本号
OsTag	String	是	-	操作系统镜像标签，需用ListImages接口查询得到
SchedulerType	String	否	pbs	调度器类型，目前支持 pbs。
AccountType	String	否	nis	域账号服务类型，目前支持 nis。
Application.n.Tag	String	是	-	第n个（n从1开始编号，可以有多条）应用软件的标签(SoftwareTag)，软件标签可以用ListSoftwares接口查询得到。例如 OpenMPI_11.1。
SecurityGroupId	String	否	无	使用已有安全组的安全组Id
SecurityGroupName	String	否	无	如果不使用已有安全组（SecurityGroupId为空），则使用这个名字创建新安全组，应用默认策略。格式要求参考ECS安全组名字。
VSwitchId	String	是	-	VPC中交换机ID。产品目前只支持VPC网络。
VolumeType	String	否	nas	网络共享存储类型，目前仅支持阿里云NAS。
VolumeId	String	是	-	阿里云NAS实例Id。目前不支持自动创建阿里云NAS实例。
VolumeProtocal	String	否	nfs	网络共享存储协议，目前仅支持nfs。
VolumeMountpoint	String	是	-	NAS vpc挂载点。目前不支持自动创建阿里云NAS挂载点。
RemoteDirectory	String	否	-	挂载共享存储的远程目录。最终挂载路径为挂载点与远程目录组合：NasMountpoint:/RemoteDirectory
HaEnable	Boolean	否	false	是否开启高可用，若开启，集群中的每种管控角色将会使用主备2台实例。
EcsChargeType	String	否	PostPaid	集群使用ECS实例的付费类型，PostPaid：按量付费，PrePaid：包年包月。若选择包年包月类型，默认开启自动续费，节点释放后将关闭自动续费。目前仅支持按量付费。
EcsOrder.Manager.InstanceType	String	是	-	集群管控节点实例规格
EcsOrder.Compute.Count	Integer	是	-	集群计算节点数量。1-99整数值。
EcsOrder.Compute.InstanceType	String	是	-	集群计算节点实例规格
EcsOrder.Login.Count	Integer	是	无	集群登录节点数量。1-99整数值。
EcsOrder.Login.InstanceType	String	是	-	集群登录节点实例规格
Password	String	否，同KeyPairName二选一	无	跳板机(Login节点)的root密码。8-30个字符，必须同时包含三项（大、小写字母，数字和特殊符号）。支持以下特殊字符：( ) ` ~ ! @ # $ % ^ & * - + = \	{ } [ ] : ; ‘ < > , . ? / 请务必使用HTTPS协议调用API以避免可能发生的密码泄露。
KeyPairName	String	否，同Password二选一	无	密钥对名称。要使用ECS密钥对功能，请在ECS控制台创建密钥对。

返回参数
除公共返回参数外返回如下结果：

字段	类型	描述
ClusterId	String	集群Id

错误码

Code	解释	http Code
InvalidParams	无效的参数	400
InvalidVpc	VPC信息无效	400
InvalidVolumn	存储卷无效	400
TooManyClusters	用户EHPC集群超过配额	403
TooManyNodes	用户节点数超过配额	403
EcsError	ECS接口调用失败	406
NotAuthorized	未授权RAM	407
UnknownError	未知错误	500

DeleteCluster 释放集群
请求参数

字段	类型	是否必须	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：DeleteCluster
RegionId	String	是	-	地域ID
ClusterId	String	是	-	集群ID
ReleaseInstance	String	否	true	是否释放由EHPC创建的实例

返回参数
公共参数。

错误码

Code	解释
InvalidParams	无效的参数
InvalidStatus	集群状态不允许此操作
EcsError	ECS接口调用失败
UnknownError	未知错误

ModifyClusterAttributes 修改集群属性
修改已有集群的属性，目前仅支持修改 Name。

请求参数

字段	类型	是否必须	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：ModifyClusterAttributes。
RegionId	String	是	-	地域ID
ClusterId	String	是	-	集群ID
Name	String	否	无	集群新名字
Description	String	否	无	集群描述，2~128个字符。

返回参数
公共参数。

错误码

Code	解释
InvalidParams	无效的参数
UnknownError	未知错误

ListClusters 查询集群列表


请求参数

字段	类型	是否必须	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：ListClusters
RegionId	String	是	-	地域ID
PageNumber	Integer	否	1	显示的页码，起始值为 1
PageSize	Integer	否	10	每页显示的条数，1-50

返回参数
公共参数和以下参数：

字段	类型	描述
Clusters	Array\<clusterinfosimple\ style="box-sizing: border-box;">	集群简要信息数组，ClusterInfoSimple结构见下面的对象描述
TotalCount	Integer	列表条目总数
PageNumber	Integer	当前页码
PageSize	Integer	本页条数

其中，每个ClusterInfoSimple结构包含以下字段：

字段	取值	描述
Id	String	集群ID
RegionId	String	地域ID
Name	String	集群名字
Description	String	集群描述
Status	String	集群状态
OsTag	String	操作系统镜像标签，可以通过ListImages查询操作系统详情。
AccountType	String	账户服务器类型，现在仅支持’nis’
SchedulerType	String	调度服务器类型，现在仅支持’pbs’
Count	Integer	集群中计算节点的数目
InstanceType	String	集群中计算节点的规格，例如ecs.n1.large
CreateTime	String	创建时间

集群状态Status的可能取值：| 取值 | 描述 || ————- | —— || uninit | 未初始化 || creating | 创建中 || init | 初始化中 || running | 运行中 || exception | 异常 || releasing | 释放中 |

错误码

Code	解释
InvalidParams	无效的参数
EcsError	ECS接口调用失败
UnknownError	未知错误

DescribeCluster 查询单个集群信息
查询指定集群的详细信息。

请求参数

字段	类型	是否必须	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：DescribeCluster。
RegionId	String	是	-	地域ID
ClusterId	String	是	-	集群ID

返回参数
公共参数和以下参数：

字段	类型	描述
ClusterInfo	ClusterInfo	集群详细信息，ClusterInfo结构见下面的对象描述

其中，ClusterInfo元素包含以下字段：

字段	取值	描述
Id	String	集群ID
RegionId	String	地域ID
Name	String	集群名字
Description	String	集群描述
Status	String	集群状态
OsTag	String	操作系统镜像标签，可以通过ListImages查询操作系统详情。
AccountType	String	账户服务器类型，现在仅支持’nis’
SchedulerType	String	调度服务器类型，现在仅支持’pbs’
CreateTime	String	创建时间
ApplicationInfo	Array\<applicationinfo\ style="box-sizing: border-box;">	集群应用软件列表，每条包含一个软件的名称Name、版本号Version
SecurityGroupId	String	安全组Id
VSwitchId	String	VPC中交换机ID。产品目前只支持VPC网络。
VolumeType	String	网络共享存储类型，目前仅支持阿里云NAS。
VolumeId	String	阿里云NAS实例Id。目前不支持自动创建阿里云NAS实例。
VolumeProtocal	String	网络共享存储协议，目前仅支持nfs。
VolumeMountpoint	String	NAS vpc挂载点。目前不支持自动创建阿里云NAS挂载点。
RemoteDirectory	String	挂载共享存储的远程目录。最终挂载路径为挂载点与远程目录组合：NasMountpoint:/RemoteDirectory
HaEnable	Boolean	是否开启高可用，若开启，集群中的每种管控角色将会使用主备2台实例。
EcsInfo	EcsInfoType	描述集群各种组件的ECS数量和规格的数据结构。如果API以JSON格式返回数据，将得到类似如下结果：EcsInfo:{“Manager”:{“Count”:2,”InstanceType”:”ecs.n1.large”},”Compute”:{“Count”:8,”InstanceType”:”ecs.n1.large”},”Login”:{“Count”:1,”InstanceType”:”ecs.n1.large”}}。XML格式的结果可以类推。
EcsChargeType	String	集群使用ECS实例的付费类型，PostPaid：按量付费，PrePaid：包年包月。若选择包年包月类型，默认开启自动续费，节点释放后将关闭自动续费。目前仅支持按量付费。目前仅支持按量付费
KeyPairName	String	如果使用ECS密钥对作为集群跳板机登录方式，返回密钥对名称。

其中节点状态Status的可能取值，参考ListClusters接口描述。
其中，ApplicationInfo结构的格式如下：

字段	类型	描述
Tag	String	软件标签。例如：OpenMPI_1.8.7。
Name	String	软件名称
Version	String	软件版本

错误码

Code	解释
InvalidParams	无效的参数
EcsError	ECS接口调用失败
UnknownError	未知错误