集群管理API-问答-阿里云开发者社区-阿里云

开发者社区> 问答> 正文

集群管理API

反向一觉 2017-10-26 14:04:53 1619

CreateCluster 创建集群
请求参数

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


返回参数
除公共返回参数外返回如下结果:
字段类型描述
ClusterIdString集群Id


错误码

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


DeleteCluster 释放集群
请求参数

字段类型是否必须默认值描述
ActionString-操作接口名,系统规定参数,取值:DeleteCluster
RegionIdString-地域ID
ClusterIdString-集群ID
ReleaseInstanceStringtrue是否释放由EHPC创建的实例


返回参数
公共参数。

错误码

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


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

请求参数
字段类型是否必须默认值描述
ActionString-操作接口名,系统规定参数,取值:ModifyClusterAttributes。
RegionIdString-地域ID
ClusterIdString-集群ID
NameString集群新名字
DescriptionString集群描述,2~128个字符。


返回参数
公共参数。

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


ListClusters 查询集群列表


请求参数
字段类型是否必须默认值描述
ActionString-操作接口名,系统规定参数,取值:ListClusters
RegionIdString-地域ID
PageNumberInteger1显示的页码,起始值为 1
PageSizeInteger10每页显示的条数,1-50


返回参数
公共参数和以下参数:
字段类型描述
ClustersArray\<clusterinfosimple\ style="box-sizing: border-box;">集群简要信息数组,ClusterInfoSimple结构见下面的对象描述
TotalCountInteger列表条目总数
PageNumberInteger当前页码
PageSizeInteger本页条数

其中,每个ClusterInfoSimple结构包含以下字段:
字段取值描述
IdString集群ID
RegionIdString地域ID
NameString集群名字
DescriptionString集群描述
StatusString集群状态
OsTagString操作系统镜像标签,可以通过ListImages查询操作系统详情。
AccountTypeString账户服务器类型,现在仅支持’nis’
SchedulerTypeString调度服务器类型,现在仅支持’pbs’
CountInteger集群中计算节点的数目
InstanceTypeString集群中计算节点的规格,例如ecs.n1.large
CreateTimeString创建时间

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

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


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

请求参数
字段类型是否必须默认值描述
ActionString-操作接口名,系统规定参数,取值:DescribeCluster。
RegionIdString-地域ID
ClusterIdString-集群ID


返回参数
公共参数和以下参数:
字段类型描述
ClusterInfoClusterInfo集群详细信息,ClusterInfo结构见下面的对象描述

其中,ClusterInfo元素包含以下字段:
字段取值描述
IdString集群ID
RegionIdString地域ID
NameString集群名字
DescriptionString集群描述
StatusString集群状态
OsTagString操作系统镜像标签,可以通过ListImages查询操作系统详情。
AccountTypeString账户服务器类型,现在仅支持’nis’
SchedulerTypeString调度服务器类型,现在仅支持’pbs’
CreateTimeString创建时间
ApplicationInfoArray\<applicationinfo\ style="box-sizing: border-box;">集群应用软件列表,每条包含一个软件的名称Name、版本号Version
SecurityGroupIdString安全组Id
VSwitchIdStringVPC中交换机ID。产品目前只支持VPC网络。
VolumeTypeString网络共享存储类型,目前仅支持阿里云NAS。
VolumeIdString阿里云NAS实例Id。目前不支持自动创建阿里云NAS实例。
VolumeProtocalString网络共享存储协议,目前仅支持nfs。
VolumeMountpointStringNAS vpc挂载点。目前不支持自动创建阿里云NAS挂载点。
RemoteDirectoryString挂载共享存储的远程目录。最终挂载路径为挂载点与远程目录组合:NasMountpoint:/RemoteDirectory
HaEnableBoolean是否开启高可用,若开启,集群中的每种管控角色将会使用主备2台实例。
EcsInfoEcsInfoType描述集群各种组件的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格式的结果可以类推。
EcsChargeTypeString集群使用ECS实例的付费类型,PostPaid:按量付费,PrePaid:包年包月。若选择包年包月类型,默认开启自动续费,节点释放后将关闭自动续费。目前仅支持按量付费。目前仅支持按量付费
KeyPairNameString如果使用ECS密钥对作为集群跳板机登录方式,返回密钥对名称。

其中节点状态Status的可能取值,参考ListClusters接口描述。
其中,ApplicationInfo结构的格式如下:
字段类型描述
TagString软件标签。例如:OpenMPI_1.8.7。
NameString软件名称
VersionString软件版本


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

存储 XML 弹性计算 JSON API 调度 文件存储 数据安全/隐私保护 数据格式
分享到
取消 提交回答
全部回答(0)
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

推荐文章
相似问题