全部产品
云市场

DescribeCluster

更新时间:2018-08-08 12:27:57

查询单个集群信息。

描述

查询指定集群的详细信息。查询单个集群信息前,您可以:

请求参数

名称 类型 是否必需 默认值 描述
Action String - 操作接口名,系统规定参数,取值:DescribeCluster
RegionId String - 地域 ID。
ClusterId String - 集群 ID。

返回参数

公共返回参数外返回如下结果:

名称 类型 描述
ClusterInfo Array<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 创建时间。
ErrorMessage String 集群异常时候的错误消息描述。
Applications Array<ApplicationInfo> 集群应用软件列表,每条包含一个软件的名称 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 密钥对作为集群跳板机登录方式,返回密钥对名称。
SccClusterId String 集群使用的 SccClusterId,如果集群不是 SCC 机型则为空
ClientVersion String 集群所使用的客户端版本号.
ImageOwnerAlias String 镜像类型,取值:systemselfothersmarketplace
ImageId String 镜像 Id。
DeployMode String 部署模式:
Standard: 账号节点 + 调度节点 + 登录节点 + 计算节点
Advanced: HA 模式
Simple: (账号 + 调度)节点 + 登录节点 + 计算节点
Tiny:(账号 + 调度 + 登录)节点 + 计算节点
OneBox:(账号 + 调度 + 登录 + 计算)节点 + 更多计算节点
PostInstallScripts Array<PostInstallScriptInfo > 安装后脚本列表。

其中节点状态 Status 的可能取值,参考 ListClusters 接口描述。

其中,ApplicationInfo 结构的格式如下:

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

其中,PostInstallScriptInfo 结构的格式如下:

名称 类型 描述
Url String 脚本下载路径。
Args String 脚本执行参数。

示例

请求示例

  1. https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeCluster&RegionId=cn-hangzhou&ClusterId=<集群ID>&<公共请求参数>

返回示例

XML格式

  1. <DescribeClusterResponse>
  2. <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  3. <ClusterInfo>
  4. <Id>ehpc-hz-4VMqwGqwbj</Id>
  5. <RegionId>cn-hangzhou</RegionId>
  6. <ZoneId>cn-hangzhou-e</ZoneId>
  7. <Name>Example-cluster-name</Name>
  8. <Description>Example cluster description</Description>
  9. <Status>running</Status>
  10. <OsTag>CentOS_7.2_64</OsTag>
  11. <AccountType>nis</AccountType>
  12. <SchedulerType>pbs</SchedulerType>
  13. <CreateTime>2018-05-30T03:08:06.000Z</CreateTime>
  14. <SecurityGroupId>sg-bp150ikdq93ww5rpdjnj</SecurityGroupId>
  15. <VpcId>vpc-bp1pxkcvmmz53ki89obb7</VpcId>
  16. <VSwitchId>vsw-bp16z86z058jauwk3pgw2</VSwitchId>
  17. <VolumeType>nas</VolumeType>
  18. <VolumeId>008b648bcb</VolumeId>
  19. <VolumeProtocol>nfs</VolumeProtocol>
  20. <VolumeMountpoint>008b648bcb-sca54.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>
  21. <RemoteDirectory>/</RemoteDirectory>
  22. <DeployMode>Standard</DeployMode>
  23. <HaEnable>false</HaEnable>
  24. <ClientVersion>1.0.16</ClientVersion>
  25. <ImageOwnerAlias>system</ImageOwnerAlias>
  26. <ImageId>centos_7_02_64_20G_alibase_20170818.vhd</ImageId>
  27. <Location>public_cloud</Location>
  28. <Applications>
  29. <ApplicationInfo>
  30. <Name>openmpi</Name>
  31. <Version>1.10.7</Version>
  32. </ApplicationInfo>
  33. </Applications>
  34. <EcsInfo>
  35. <Manager>
  36. <Count>2</Count>
  37. <InstanceType>ecs.n1.tiny</InstanceType>
  38. </Manager>
  39. <Compute>
  40. <Count>1</Count>
  41. <InstanceType>ecs.n1.tiny</InstanceType>
  42. </Compute>
  43. <Login>
  44. <Count>1</Count>
  45. <InstanceType>ecs.n1.tiny</InstanceType>
  46. </Login>
  47. </EcsInfo>
  48. </ClusterInfo>
  49. </DescribeClusterResponse>

JSON格式

  1. {
  2. "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  3. "ClusterInfo": {
  4. "Id": "ehpc-hz-4VMqwGqwbj",
  5. "RegionId": "cn-hangzhou",
  6. "ZoneId": "cn-hangzhou-e",
  7. "Name": "Example-cluster-name",
  8. "Description": "Example cluster description",
  9. "Status": "running",
  10. "OsTag": "CentOS_7.2_64"
  11. "AccountType": "nis",
  12. "SchedulerType": "pbs",
  13. "CreateTime": "2018-05-30T03:08:06.000Z",
  14. "SecurityGroupId": "sg-bp150ikdq93ww5rpdjnj",
  15. "VpcId": "vpc-bp1pxkcvmmz53ki89obb7",
  16. "VSwitchId": "vsw-bp16z86z058jauwk3pgw2",
  17. "VolumeType": "nas",
  18. "VolumeId": "008b648bcb",
  19. "VolumeProtocol": "nfs",
  20. "VolumeMountpoint": "008b648bcb-sca54.cn-hangzhou.nas.aliyuncs.com",
  21. "RemoteDirectory": "/",
  22. "DeployMode": "Standard",
  23. "HaEnable": false,
  24. "ClientVersion": "1.0.16"
  25. "ImageOwnerAlias": "system",
  26. "ImageId": "centos_7_02_64_20G_alibase_20170818.vhd",
  27. "Location": "public_cloud",
  28. "Applications" : {
  29. "ApplicationInfo" : [
  30. {
  31. "Name": "openmpi",
  32. "Version": "1.10.7"
  33. }
  34. ]
  35. },
  36. "EcsInfo": {
  37. "Manager": {
  38. "Count": 2,
  39. "InstanceType": "ecs.n1.tiny"
  40. },
  41. "Compute": {
  42. "Count": 1,
  43. "InstanceType": "ecs.n1.tiny"
  44. },
  45. "Login": {
  46. "Count": 1,
  47. "InstanceType": "ecs.n1.tiny"
  48. }
  49. }
  50. }
  51. }

错误码

查询 E-HPC 接口错误码请访问 错误码。更多错误码,请访问 API 错误中心