调用DescribeCluster查询指定集群信息。

调试

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

请求参数

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

系统规定参数。取值：DescribeCluster
ClusterId String 是 ehpc-hz-QKKVqO****

集群ID。您可以调用ListClusters查询指定地域下的集群列表。

返回数据

名称 类型 示例值 描述
ClusterInfo Struct

集群信息。
AccountType String nis

账户服务器类型。可能值：

  • nis
  • ldap
Applications Array of ApplicationInfo

集群应用软件列表，包含软件的名称和版本号。
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 2020-12-24T03:18:23.000Z

集群创建时间。
DeployMode String Simple

集群部署模式。可能值：

  • Standard：账号节点、调度节点、登录节点、计算节点分离部署。
  • Advanced：HA模式部署。
  • Simple：账号节点和调度节点混合部署在一个节点上，登录节点和计算节点分离部署。
  • Tiny：账号节点、调度节点、登录节点混合部署在一个节点上，计算节点分离部署。
  • OneBox：账号节点、调度节点、登录节点、计算节点混合部署在一个节点上。
Description String cluster

集群描述。
EcsChargeType String PostPaid

集群实例付费类型。可能值：

  • PostPaid：按量付费
  • PrePaid：包年包月
EcsInfo Struct

描述集群中ECS数量和规格的数据结构。
Compute Struct

计算节点信息。
Count Integer 1

计算节点数量。
InstanceType String ecs.n1.tiny

计算节点ECS实例规格。
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-bp15de54eet1c43f****

实例ID。
ImageId String centos_7_02_64_20G_alibase_20170818****

镜像ID。
ImageName String test_for_Image

镜像名称。
ImageOwnerAlias String system

镜像类型。可能值：

  • system：公共镜像
  • self：自定义镜像
  • others：共享镜像
  • marketplace：镜像市场镜像
KeyPairName String test

密钥对名称。
Location String PublicCloud

集群所在位置。可能值：

  • OnPremise：混合云集群。
  • PublicCloud：公有云集群。
Name String cluster

集群名称。
OsTag String CentOS_7.2_64

操作系统镜像标签。
PostInstallScripts Array of PostInstallScriptInfo

安装后脚本列表。
PostInstallScriptInfo
Args String bash file.sh

脚本执行参数。
Url String example.com

脚本下载路径。
RegionId String cn-hangzhou

地域ID。
RemoteDirectory String NasMountpoint:/RemoteDirectory

挂载共享存储的远程目录。
SccClusterId String 00b648b****

集群使用的SccCluster ID。如果集群不是SCC机型则为空。
SchedulerType String pbs

调度服务器类型。可能值范围：

  • pbs
  • slurm
  • opengridscheduler
  • deadline
SecurityGroupId String sg-bp1asugr34gzn****

安全组ID。
Status String creating

集群状态。可能值：

  • uninit：未初始化
  • creating：创建中
  • Init：初始化中
  • running：运行中
  • exception：异常
  • releasing：释放中
VSwitchId String vsw-bp1e47optm9g58zcu****

VPC中交换机ID。产品目前只支持VPC网络。
VolumeId String 008b64****

阿里云NAS实例ID。目前不支持自动创建阿里云NAS实例。
VolumeMountpoint String 008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com

NAS的VPC挂载点。目前不支持自动创建阿里云NAS挂载点。
VolumeProtocol String nfs

网络共享存储协议。可能值：

  • nfs
  • smb
VolumeType String NAS

网络共享存储类型，目前仅支持阿里云NAS。
VpcId String vpc-bp1pxkcvmmz53ki89****

专有网络ID。
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

请求ID。

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeCluster
&ClusterId=ehpc-hz-QKKVqO****
&<公共请求参数>

正常返回示例

XML格式 

<DescribeClusterResponse>
      <ClusterInfo>
            <SecurityGroupId>sg-bp1asugr34gzn****</SecurityGroupId>
            <ImageId>centos_7_02_64_20G_alibase_20170818****</ImageId>
            <DeployMode>Standard</DeployMode>
            <ClientVersion>1.0.64</ClientVersion>
            <ImageOwnerAlias>system</ImageOwnerAlias>
            <VSwitchId>vsw-bp1e47optm9g58zcu****</VSwitchId>
            <SchedulerType>pbs</SchedulerType>
            <VpcId>vpc-bp1gnu8br4ay7beb2****</VpcId>
            <VolumeId>008b64****</VolumeId>
            <VolumeType>nas</VolumeType>
            <Applications>
                  <ApplicationInfo>
                        <Name>openmpi</Name>
                        <Version>1.10</Version>
                  </ApplicationInfo>
                  <ApplicationInfo>
                        <Name>tensorflow-gpu</Name>
                        <Version>1.7.0-cp27-pypi</Version>
                  </ApplicationInfo>
            </Applications>
            <VolumeProtocol>nfs</VolumeProtocol>
            <VolumeMountpoint>035bb49518-e****.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>
            <AccountType>nis</AccountType>
            <PostInstallScripts>
        </PostInstallScripts>
            <Description></Description>
            <EcsInfo>
                  <Login>
                        <Count>1</Count>
                        <InstanceType>ecs.n1.tiny</InstanceType>
                  </Login>
                  <Manager>
                        <Count>1</Count>
                        <InstanceType>ecs.n1.tiny</InstanceType>
                  </Manager>
                  <Compute>
                        <Count>1</Count>
                        <InstanceType>ecs.n1.tiny</InstanceType>
                  </Compute>
            </EcsInfo>
            <Location>PublicCloud</Location>
            <HaEnable>false</HaEnable>
            <Name>cluster</Name>
            <Status>creating</Status>
            <RemoteDirectory>/</RemoteDirectory>
            <RegionId>cn-hangzhou</RegionId>
            <CreateTime>2020-12-24T03:18:23.000Z</CreateTime>
            <Id>ehpc-hz-FYUr32****</Id>
            <OsTag>CentOS_7.2_64</OsTag>
      </ClusterInfo>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</DescribeClusterResponse>

JSON格式 

{
	"ClusterInfo": {
		"SecurityGroupId": "sg-bp1asugr34gzn****",
		"ImageId": "centos_7_02_64_20G_alibase_20170818****",
		"DeployMode": "Standard",
		"ClientVersion": "1.0.64",
		"ImageOwnerAlias": "system",
		"VSwitchId": "vsw-bp1e47optm9g58zcu****",
		"SchedulerType": "pbs",
		"VpcId": "vpc-bp1gnu8br4ay7beb2****",
		"VolumeId": "008b64****",
		"VolumeType": "nas",
		"Applications":{
			"ApplicationInfo": [
				{
					"Name": "openmpi",
					"Version": "1.10"
				},
				{
					"Name": "tensorflow-gpu",
					"Version": "1.7.0-cp27-pypi"
				}
			]
		},
		"VolumeProtocol": "nfs",
		"VolumeMountpoint": "035bb49518-e****.cn-hangzhou.nas.aliyuncs.com",
		"AccountType": "nis",
		"PostInstallScripts": {
			"PostInstallScriptInfo": []
		},
		"Description": "",
		"EcsInfo":{
			"Login":{
				"Count":1,
				"InstanceType":"ecs.n1.tiny"
			},
			"Manager":{
				"Count":1,
				"InstanceType": "ecs.n1.tiny"
			},
			"Compute":{
				"Count":1,
				"InstanceType": "ecs.n1.tiny"
			}
		},
		"Location": "PublicCloud",
		"HaEnable":false,
		"Name": "cluster",
		"Status": "creating",
		"RemoteDirectory": "/",
		"RegionId": "cn-hangzhou",
		"CreateTime": "2020-12-24T03:18:23.000Z",
		"Id": "ehpc-hz-FYUr32****",
		"OsTag": "CentOS_7.2_64"
	},
	"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

错误码

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

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