查询单个集群信息。

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCluster

操作接口名,系统规定参数,取值:DescribeCluster。

ClusterId String ehpc-hz-QKKVqOJ2Ym

集群 ID。

返回数据

名称 类型 示例值 描述
ClusterInfo Struct

集群信息。

AccountType String nis

账户服务器类型,现在仅支持 nis。

Applications Array of ApplicationInfo

集群应用软件列表,每条包含一个软件的名称 Name、版本号 Version。

ApplicationInfo
Name String openmpi

应用软件名称。

Tag String OpenMPI_1.8.7

应用软件标签。

Version String 1.10

应用软件版本。

BaseOsTag String CentOS_7.2_64

集群基础镜像。

ClientVersion String 1.0.1

集群所使用的客户端版本号。

CreateTime String 2018-05-30T03:08:06.000Z

集群创建时间。

DeployMode String Simple

部署模式:

  • Standard:账号节点+调度节点+登录节点+计算节点
  • Advanced:HA模式
  • Simple:(账号+调度)节点+登录节点+计算节点
  • Tiny:(账号+调度+登录)节点+计算节点
  • OneBox:(账号+调度+登录+计算)节点+更多计算节点
Description String cluster

集群描述。

EcsChargeType String PostPaid

集群使用 ECS 实例的付费类型,PostPaid:按量付费,PrePaid:包年包月。若选择包年包月类型,默认开启自动续费,节点释放后将关闭自动续费。

EcsInfo Struct

描述集群各种组件的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格式的结果可以类推。

Compute Struct

计算节点信息。

Count Integer 1

计算节点数量。

InstanceType String ecs.n1.tiny

登录节点。

Login Struct

登录节点信息。

Count Integer 1

登录节点数量。

InstanceType String ecs.n1.tiny

实例规格。

Manager Struct

管控节点信息。

Count Integer 1

管控节点数量。

InstanceType String ecs.n1.tiny

实例规格。

HaEnable Boolean false

是否开启高可用,若开启,集群中的每种管控角色将会使用主备 2 台实例。

Id String i-bp15de54eet1c43fn7ay

实例ID。

ImageId String centos_7_02_64_20G_alibase_20170818.vhd

镜像 ID。

ImageName String test_for_xxxxx

镜像名称。

ImageOwnerAlias String system

镜像类型:system、self、others 或 marketplace。

KeyPairName String test

密钥对名称。要使用 ECS 密钥对功能,请在 ECS 控制台创建密钥对。

Location String public_cloud

Location信息。

Name String cluster

集群名称。

OsTag String CentOS_7.2_64

操作系统镜像标签,可以通过ListImages查询操作系统详情。

PostInstallScripts Array of PostInstallScriptInfo

安装后脚本列表。

PostInstallScriptInfo
Args String bash file.sh

脚本执行参数。

Url String example.com

脚本下载路径。

RegionId String cn-hangzhou

地域ID。

RemoteDirectory String NasMountpoint:/RemoteDirectory

挂载共享存储的远程目录。最终挂载路径为挂载点与远程目录组合:NasMountpoint:/RemoteDirectory。

SccClusterId String 12345

集群使用的 SccClusterId,如果集群不是 SCC 机型则为空。

SchedulerType String pbs

调度服务器类型,现在仅支持 pbs。

SecurityGroupId String sg-bp1asugr34gznXXXX

安全组ID。

Status String creating

集群状态。

VSwitchId String vsw-bp1e47optm9g58zcup0de

VPC 中交换机 ID。产品目前只支持 VPC 网络。

VolumeId String 008b648bcb

阿里云 NAS 实例ID。目前不支持自动创建阿里云 NAS 实例。

VolumeMountpoint String 008b648bcb-sca54.cn-hangzhou.nas.aliyuncs.com

NAS vpc 挂载点。目前不支持自动创建阿里云 NAS 挂载点。

VolumeProtocol String nfs

网络共享存储协议,目前仅支持 nfs。

VolumeType String nas

网络共享存储类型,目前仅支持阿里云 NAS。

VpcId String vpc-bp1pxkcvmmz53ki89obb7

专有网络ID。

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCluster
&ClusterId=ehpc-hz-QKKVqOJ2Ym
&<公共请求参数>

正常返回示例

XML 格式

<DescribeClusterResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
      <ClusterInfo>
            <Id>ehpc-hz-4VMqwGqwbj</Id>
            <RegionId>cn-hangzhou</RegionId>
            <ZoneId>cn-hangzhou-e</ZoneId>
            <Name>Example-cluster-name</Name>
            <Description>Example cluster description</Description>
            <Status>running</Status>
            <OsTag>CentOS_7.2_64</OsTag>
            <AccountType>nis</AccountType>
            <SchedulerType>pbs</SchedulerType>
            <CreateTime>2018-05-30T03:08:06.000Z</CreateTime>
            <SecurityGroupId>sg-bp150ikdq93ww5rpdjnj</SecurityGroupId>
            <VpcId>vpc-bp1pxkcvmmz53ki89obb7</VpcId>
            <VSwitchId>vsw-bp16z86z058jauwk3pgw2</VSwitchId>
            <VolumeType>nas</VolumeType>
            <VolumeId>008b648bcb</VolumeId>
            <VolumeProtocol>nfs</VolumeProtocol>
            <VolumeMountpoint>008b648bcb-sca54.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>
            <RemoteDirectory>/</RemoteDirectory>
            <DeployMode>Standard</DeployMode>
            <HaEnable>false</HaEnable>
            <ClientVersion>1.0.16</ClientVersion>
            <ImageOwnerAlias>system</ImageOwnerAlias>
            <ImageId>centos_7_02_64_20G_alibase_20170818.vhd</ImageId>
            <Location>public_cloud</Location>
            <Applications>
                  <ApplicationInfo>
                        <Name>openmpi</Name>
                        <Version>1.10.7</Version>
                  </ApplicationInfo>
            </Applications>
            <EcsInfo>
                  <Manager>
                        <Count>2</Count>
                        <InstanceType>ecs.n1.tiny</InstanceType>
                  </Manager>
                  <Compute>
                        <Count>1</Count>
                        <InstanceType>ecs.n1.tiny</InstanceType>
                  </Compute>
                  <Login>
                        <Count>1</Count>
                        <InstanceType>ecs.n1.tiny</InstanceType>
                  </Login>
            </EcsInfo>
      </ClusterInfo>
</DescribeClusterResponse>

JSON 格式

{
	"ClusterInfo": {
		"SecurityGroupId": "sg-bp1asugr34gznjaz2x4z",
		"ImageId": "centos_7_02_64_20G_alibase_20170818.vhd",
		"DeployMode": "Standard",
		"ClientVersion": "1.0.64",
		"ImageOwnerAlias": "system",
		"VSwitchId": "vsw-bp1e47optm9g58zcup0de",
		"SchedulerType": "pbs",
		"VpcId": "vpc-bp1gnu8br4ay7beb2wxl8",
		"VolumeId": "035bb49518",
		"VolumeType": "nas",
		"Applications": {
			"ApplicationInfo": [
				{
					"Name": "cuda-toolkit",
					"Version": "9.0"
				},
				{
					"Name": "tensorflow-gpu",
					"Version": "1.7.0-cp27-pypi"
				}
			]
		},
		"VolumeProtocol": "nfs",
		"VolumeMountpoint": "035bb49518-ect54.cn-hangzhou.nas.aliyuncs.com",
		"AccountType": "nis",
		"PostInstallScripts": {
			"PostInstallScriptInfo": []
		},
		"Description": "",
		"EcsInfo": {
			"Login": {
				"Count": 0,
				"InstanceType": "ecs.n1.tiny"
			},
			"Manager": {
				"Count": 1,
				"InstanceType": "ecs.n1.tiny"
			},
			"Compute": {
				"Count": 0,
				"InstanceType": "ecs.n1.tiny"
			}
		},
		"Location": "PublicCloud",
		"HaEnable": false,
		"Name": "cluster",
		"Status": "creating",
		"RemoteDirectory": "/",
		"RegionId": "cn-hangzhou",
		"CreateTime": "2019-09-18T13:24:13.000Z",
		"Id": "ehpc-hz-FYUr32H5yi",
		"OsTag": "CentOS_7.2_64"
	},
	"RequestId": "D8839FDD-A580-4AAB-AA04-F8E49D11DA84"
}

错误码

HttpCode 错误码 错误信息 描述
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败,服务暂时不可用

访问错误中心查看更多错误码。