Queries a specified cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCluster

The operation that you want to perform. Set the value to DescribeCluster.

ClusterId String Yes ehpc-hz-QKKVqO****

The ID of the cluster. You can call the ListClusters operation to query the list of clusters in a specified region.

Response parameters

Parameter Type Example Description
ClusterInfo Struct

The information of the cluster.

AccountType String nis

The server type of the account. Valid values:

  • nis
  • ldap
Applications Array of ApplicationInfo

The array of the applications in the cluster. The array contains the name and version number of the software.

ApplicationInfo
Name String openmpi

The name of the application.

Tag String OpenMPI_1.8.7

The tag of the application.

Version String 1.10

The version of the application.

BaseOsTag String CentOS_7.2_64

The base image of the cluster.

ClientVersion String 1.0.1

The version number of the client that is used by the cluster.

CreateTime String 2020-12-24T03:18:23.000Z

The time when the cluster was created.

DeployMode String Simple

The deployment mode of the cluster. Valid values:

  • Standard: An account node, a scheduler node, a logon node, and several compute nodes are separately deployed.
  • Advanced: Two high availability (HA) account nodes, two HA scheduler nodes, one logon node, and several compute nodes are separately deployed.
  • Simple: A cluster management node, a logon node, and several compute nodes are deployed. The account management and job scheduler services are deployed on the cluster management node.
  • Tiny: The account management, job scheduler, and logon services are deployed on a single node. Several compute nodes are separately deployed.
  • OneBox: An account node, a scheduler node, a logon node, and a compute node are all deployed on one node.
Description String cluster

The description of the cluster.

EcsChargeType String PostPaid

The billing method of the instances that are deployed on the cluster. Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription
EcsInfo Struct

A data structure that describes the number and types of ECS instances in the cluster.

Compute Struct

The statistics of compute nodes in the cluster.

Count Integer 1

The number of compute nodes in the cluster.

InstanceType String ecs.n1.tiny

The ECS instance type of compute nodes.

Login Struct

The information of logon nodes.

Count Integer 1

The number of logon nodes in the cluster.

InstanceType String ecs.n1.tiny

The instance type of logon nodes.

Manager Struct

The information of management nodes.

Count Integer 1

The number of management nodes.

InstanceType String ecs.n1.tiny

The instance type of the cluster management nodes.

HaEnable Boolean false

Specifies whether to enable the high availability feature.

Note If it is enabled, each management role in the cluster will use one primary instance and one secondary instance.
Id String i-bp15de54eet1c43f****

The ID of the instance.

ImageId String centos_7_02_64_20G_alibase_20170818****

The ID of the image.

ImageName String test_for_Image

The name of the image.

ImageOwnerAlias String system

The type of image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image
  • marketplace: Alibaba Cloud Marketplace image
KeyPairName String test

The name of the AccessKey pair.

Location String PublicCloud

The location where the cluster is deployed. Valid values:

  • OnPremise: The cluster is deployed on a hybrid cloud cluster.
  • PublicCloud: The cluster is deployed on a public cloud cluster.
Name String cluster

The name of the cluster.

OsTag String CentOS_7.2_64

The image tag of the operating system.

PostInstallScripts Array of PostInstallScriptInfo

An array of post-installation scripts.

PostInstallScriptInfo
Args String bash file.sh

The runtime parameter of the script.

Url String example.com

The URL that is used to download the script.

RegionId String cn-hangzhou

The region ID of the instance.

RemoteDirectory String NasMountpoint:/RemoteDirectory

The remote directory that is mounted on the network shared storage.

SccClusterId String 00b648b****

The ID of the SccCluster. A null string will be returned if the instances in the cluster are not for Super Computing Cluster (SCC).

SchedulerType String pbs

The type of the scheduler. The range of valid values:

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

The ID of the security group.

Status String creating

The status of the cluster. Valid values:

  • uninit: The cluster is not initialized.
  • creating: The cluster is being created.
  • init: The cluster is being initialized.
  • running: The cluster is running.
  • exception: The cluster encounters an exception.
  • Releasing: The cluster is being released.
VSwitchId String vsw-bp1e47optm9g58zcu****

The ID of the vSwitch. E-HPC can be deployed only in virtual private clouds (VPCs).

VolumeId String 008b64****

The ID of the Apsara File Storage NAS file system. Automatic creation of NAS file systems is not supported.

VolumeMountpoint String 008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com

The NAS mount target in the VPC. Automatic creation of NAS mount targets is not supported.

VolumeProtocol String nfs

The protocol of the network shared storage. Valid values:

  • nfs
  • smb
VolumeType String NAS

The type of the network shared storage. Valid value: NAS.

VpcId String vpc-bp1pxkcvmmz53ki89****

The ID of the VPC.

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

The ID of the request.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeCluster
&ClusterId=ehpc-hz-QKKVqO****
&<Common request parameters>

Sample success responses

XML format

<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 format

{
	"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"
}

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.