DescribeCluster - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the details of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:DescribeCluster	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID. You can call the ListClusters operation to query the list of clusters in a region.	ehpc-hz-QKKVqO****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
ClusterInfo	object	The cluster information.
Status	string	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.	creating
VpcId	string	The VPC ID of the node.	vpc-bp1pxkcvmmz53ki89****
KeyPairName	string	The name of the AccessKey pair.	test
EcsChargeType	string	The billing method of the nodes in the cluster. Valid values: PostPaid: pay-as-you-go PrePaid: subscription	PostPaid
SecurityGroupId	string	The ID of the security group.	sg-bp1asugr34gzn****
SccClusterId	string	The ID of the Super Computing Cluster (SCC) instance. If the cluster is not an SCC instance, a null string is returned.	00b648b****
CreateTime	string	The time at which the instance is created.	2020-12-24T03:18:23.000Z
AccountType	string	The server type of the account. Valid values: nis ldap	nis
VolumeProtocol	string	The type of the protocol that is used by the file system. Valid values: nfs smb	nfs
Description	string	The description of the cluster.	cluster
VolumeId	string	The ID of the Apsara File Storage NAS file system. NAS file systems cannot be automatically created.	008b64****
HaEnable	boolean	Specifies whether to enable the high availability feature. Note If high availability is enabled, each management role in the cluster uses both primary and secondary instances.	false
BaseOsTag	string	The image of the cluster.	CentOS_7.2_64
Name	string	The name of the cluster.	cluster
ImageId	string	The image ID.	centos_7_02_64_20G_alibase_20170818****
SchedulerType	string	The type of the scheduler. Valid values: pbs slurm opengridscheduler deadline	pbs
SchedulerVersion	string	The version of the scheduler.	18.1.1
DeployMode	string	The mode in which the cluster is deployed. Valid values: Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed. Advanced: Two high availability (HA) account nodes, two HA scheduler nodes, one logon node, and multiple compute nodes are separately deployed. Simple: A management node, a logon node, and multiple compute nodes are deployed. The management node consists of an account node and a scheduling node. The logon node and compute nodes are separately deployed. Tiny: The account node, scheduling node, and logon node are deployed on one node. The compute node is separately deployed.	Simple
ImageOwnerAlias	string	The image type. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image	system
OsTag	string	The operating system tag of the image.	CentOS_7.2_64
VolumeMountpoint	string	The mount target of the NAS file system. The mount target is of the VPC type. Mount targets cannot be automatically created for NAS file systems.	008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com
RemoteDirectory	string	The remote directory on which the file system is mounted.	NasMountpoint:/RemoteDirectory
RegionId	string	The region ID.	cn-hangzhou
VSwitchId	string	The vSwitch ID. E-HPC can be deployed only in VPCs.	vsw-bp1e47optm9g58zcu****
ImageName	string	The image name.	test_for_Image
VolumeType	string	The type of the network shared storage. Valid value: NAS.	NAS
Location	string	The location where the cluster is deployed. Valid values: OnPremise: The node is deployed on a hybrid cloud. PublicCloud: The cluster is deployed on a public cloud.	PublicCloud
Id	string	The instance ID.	i-bp15de54eet1c43f****
ClientVersion	string	The version of the E-HPC client.	1.0.1
ZoneId	string	The zone ID.	cn-hangzhou-k
ResourceGroupId	string	The resource group ID.	rg-aek23szz5i2****
RamRoleName	string	The name of the instance Resource Access Management (RAM) role.	AliyunEHPCFullAccess
RamNodeTypes	string	The node type details of the instance RAM role.	["manager", "compute"]
Applications	object []	The array of the software in the cluster. The array contains the name and version of the software.
Tag	string	The tag of the software.	OpenMPI_1.8.7
Name	string	The name of the software.	openmpi
Version	string	The version of the software.	1.10
PostInstallScripts	object []	The list of post-installation scripts
Url	string	The URL used to download the script.	example.com
Args	string	The runtime parameter of the script.	bash file.sh
EcsInfo	object	The list of ECS instance specifications and quantity.
Manager	object	The information of management nodes.
InstanceType	string	The instance type of the management nodes.	ecs.n1.tiny
Count	integer	The number of management nodes.	1
Compute	object	The list of compute nodes.
InstanceType	string	The instance type of the compute nodes.	ecs.n1.tiny
Count	integer	The number of compute nodes in the cluster.	1
Login	object	The list of logon nodes.
InstanceType	string	The instance type of the logon nodes.	ecs.n1.tiny
Count	integer	The number of logon nodes in the cluster.	1
ProxyMgr	object	The list of proxy nodes on the cloud. This parameter is returned only when the cluster is deployed across hybrid environments and the hybrid-cloud proxy mode is enabled for the cluster.
InstanceType	string	The instance type of the proxy node.	ecs.n1.tiny
Count	integer	The number of proxy nodes.	1
OnPremiseInfo	object []	The list of on-premises management nodes. This parameter is returned only when the cluster is deployed across hybrid environments and the hybrid-cloud proxy mode is enabled for the cluster.
Type	string	The type of on-premises management nodes. Valid values: scheduler account account, scheduler	scheduler
HostName	string	The hostname of the on-premises management nodes.	testecs
IP	string	The IP address of the on-premises management nodes.	192.168..
AddOnsInfo	object []	The information about the custom component service.
SoftwareId	string	The software ID of the component.	CROMWELL_85
DeployMode	string	The deployment mode of the custom component. Valid values: local ecs	local
Port	integer	The TCP port number of the custom component.	10000
Status	string	The running status of the custom component. Valid values: running stopped exception	running
URL	string	The endpoint of the custom component service.	http://172.16.10.12:10000/
ClusterVersion	string	The version of the E-HPC cluster.	1.0
WithoutAgent	integer	Specifies whether to not install the agent.	false
Plugin	string	The mode configurations of the plug-in. This parameter takes effect only when the SchedulerType parameter is set to custom. The value must be a JSON string. The parameter contains the following parameters: pluginMod, pluginLocalPath, and pluginOssPath. pluginMod: the mode of the plug-in. The following modes are supported: oss: The plug-in is downloaded and decompressed from OSS to a local path that is specified by the pluginLocalPath parameter. image: By default, the plug-in is stored in a pre-defined local path that is specified by the pluginLocalPath parameter. pluginLocalPath: the local path where the plug-in is stored. We recommend that you select a shared directory in the oss mode and a non-shared directory in the image mode. pluginOssPath: the remote path where the plug-in is stored in OSS. This parameter takes effect only if you set the pluginMod parameter to oss.	{\"pluginMod\":\"image\",\"pluginLocalPath\":\"/opt/plugin\"}
SchedulerPreInstall	integer	Specifies whether the scheduler is preinstalled for the image. Valid values: true: The scheduler is preinstalled. When you create a node or scale out a cluster, you do not need to install the scheduler. false: The scheduler is not preinstalled. When you create or add a cluster, you must install the scheduler.	true
Domain	string	The domain name of the on-premises E-HPC cluster. This parameter takes effect only when the AccoutType parameter is set to Idap.	ldap
OpenldapPar	string	The parameter that is used to connect to the OpenLDAP server.	{ "LdapServerIp": "192.168.XX.XX", "BaseDn": "ehpctest", "FallbackHomeDir": "/home" }
WinAdPar	string	The parameter that is used to connect to the Windows AD server.	{ "AdUser": "Administrator", "AdUserPasswd": "xxxxxx", "AdDc": "ad-hybrid001.ehpcad.com", "AdIp": "192.168.XX.XX"}
Period	string	The duration of the subscription. The unit of the duration is specified by the `PeriodUnit` parameter. If you set PriceUnit to Year, the valid values of the Period parameter are 1, 2, and 3. If you set PriceUnit to Month, the valid values of the Period parameter are 1, 2, 3, 4, 5, 6, 7, 8, and 9. If you set PriceUnit to Hour, the valid value of the Period parameter is 1. Default value: 1.	1
PeriodUnit	string	The unit of the subscription duration. Valid value: Year Month Hour Default value: Month.	Month
AutoRenewPeriod	string	The auto-renewal period of the subscription compute nodes. The parameter takes effect when AutoRenew is set to true. If PeriodUnit is set to Week, the valid values of the AutoRenewPeriod parameter are 1, 2, and 3. If PeriodUnit is set to Month, the valid values of the AutoRenewPeriod parameter are 1, 2, 3, 6, and 12. Default value: 1.	1
AutoRenew	string	Specifies whether to enable auto-renewal. The parameter takes effect only when EcsChargeType is set to PrePaid. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default value: true.	false
ComputeSpotStrategy	string	The bidding method of the compute node. Valid values: NoSpot: The instance is created as a pay-as-you-go instance. SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price. SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.	NoSpot
ComputeSpotPriceLimit	string	The maximum hourly price of the compute nodes. A maximum of three decimal places can be used in the value of the parameter. The parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.	0.56
Nodes	object []	The information of the on-premises node in the cluster.
Role	string	The role of the on-premises node in the cluster. Valid values: Manager: management node Login: logon node Compute: compute node	Compute
HostName	string	The hostname of the on-premises node in the cluster.	compute000
IpAddress	string	The IP address of the on-premises node in the cluster.	192.168.XX.XX
AccountType	string	The service type of the domain account to which the on-premises node in the cluster belongs. Valid values: nis ldap Default value: nis.	nis
Dir	string	The directory of the on-premises node in the cluster.	/opt/sge/default/
SchedulerType	string	The scheduler type of the on-premises node in the cluster. Valid values: pbs slurm opengridscheduler deadline Default value: pbs.	pbs
InitialImage	object	The image information of the operating systems.
OsTag	string	An array of OS images that are supported by E-HPC.	CentOS_7.6_64
ImageOwnerAlias	string	The type of the image. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image	system
ImageId	string	The image ID.	centos_7_6_x64_20G_alibase_20211130.vhd

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ClusterInfo": {
    "Status": "creating",
    "VpcId": "vpc-bp1pxkcvmmz53ki89****",
    "KeyPairName": "test",
    "EcsChargeType": "PostPaid",
    "SecurityGroupId": "sg-bp1asugr34gzn****",
    "SccClusterId": "00b648b****",
    "CreateTime": "2020-12-24T03:18:23.000Z",
    "AccountType": "nis",
    "VolumeProtocol": "nfs",
    "Description": "cluster",
    "VolumeId": "008b64****",
    "HaEnable": false,
    "BaseOsTag": "CentOS_7.2_64",
    "Name": "cluster",
    "ImageId": "centos_7_02_64_20G_alibase_20170818****",
    "SchedulerType": "pbs",
    "SchedulerVersion": "18.1.1",
    "DeployMode": "Simple",
    "ImageOwnerAlias": "system",
    "OsTag": "CentOS_7.2_64",
    "VolumeMountpoint": "008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com",
    "RemoteDirectory": "NasMountpoint:/RemoteDirectory",
    "RegionId": "cn-hangzhou",
    "VSwitchId": "vsw-bp1e47optm9g58zcu****",
    "ImageName": "test_for_Image",
    "VolumeType": "NAS",
    "Location": "PublicCloud",
    "Id": "i-bp15de54eet1c43f****",
    "ClientVersion": "1.0.1",
    "ZoneId": "cn-hangzhou-k",
    "ResourceGroupId": "rg-aek23szz5i2****",
    "RamRoleName": "AliyunEHPCFullAccess",
    "RamNodeTypes": "[\"manager\", \"compute\"]",
    "Applications": {
      "ApplicationInfo": [
        {
          "Tag": "OpenMPI_1.8.7",
          "Name": "openmpi",
          "Version": "1.10"
        }
      ]
    },
    "PostInstallScripts": {
      "PostInstallScriptInfo": [
        {
          "Url": "example.com",
          "Args": "bash file.sh"
        }
      ]
    },
    "EcsInfo": {
      "Manager": {
        "InstanceType": "ecs.n1.tiny",
        "Count": 1
      },
      "Compute": {
        "InstanceType": "ecs.n1.tiny",
        "Count": 1
      },
      "Login": {
        "InstanceType": "ecs.n1.tiny",
        "Count": 1
      },
      "ProxyMgr": {
        "InstanceType": "ecs.n1.tiny",
        "Count": 1
      }
    },
    "OnPremiseInfo": {
      "OnPremiseInfo": [
        {
          "Type": "scheduler",
          "HostName": "testecs",
          "IP": "192.168.*.*"
        }
      ]
    },
    "AddOnsInfo": {
      "AddOnsInfo": [
        {
          "SoftwareId": "CROMWELL_85",
          "DeployMode": "local",
          "Port": 10000,
          "Status": "running",
          "URL": "http://172.16.10.12:10000/"
        }
      ]
    },
    "ClusterVersion": "1.0",
    "WithoutAgent": 0,
    "Plugin": "{\\\"pluginMod\\\":\\\"image\\\",\\\"pluginLocalPath\\\":\\\"/opt/plugin\\\"}",
    "SchedulerPreInstall": 0,
    "Domain": "ldap",
    "OpenldapPar": "{\n\t\"LdapServerIp\": \"192.168.XX.XX\",\n\t\"BaseDn\": \"ehpctest\",\n\t\"FallbackHomeDir\": \"/home\"\n}",
    "WinAdPar": "{\t\"AdUser\": \"Administrator\",\t\"AdUserPasswd\": \"xxxxxx\",\t\"AdDc\": \"ad-hybrid001.ehpcad.com\",\t\"AdIp\": \"192.168.XX.XX\"}",
    "Period": "1",
    "PeriodUnit": "Month",
    "AutoRenewPeriod": "1",
    "AutoRenew": "false",
    "ComputeSpotStrategy": "NoSpot",
    "ComputeSpotPriceLimit": "0.56",
    "Nodes": {
      "NodesInfo": [
        {
          "Role": "Compute",
          "HostName": "compute000",
          "IpAddress": "192.168.XX.XX",
          "AccountType": "nis",
          "Dir": "/opt/sge/default/",
          "SchedulerType": "pbs"
        }
      ]
    },
    "InitialImage": {
      "OsTag": "CentOS_7.6_64",
      "ImageOwnerAlias": "system",
      "ImageId": "centos_7_6_x64_20G_alibase_20211130.vhd"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
404	ImageNotFound	The specified image does not exist.	The specified image does not exist. Please verify the parameter.
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
406	NasError	NAS API request failed.	Failed to request the NAS interface.
406	AgentError	The agent service request failed.	-
406	DbError	A database service error occurred.	Database request failed.
406	RedisError	A Redis service error occurred.	Redis request failed.
406	AliyunError	An Alibaba Cloud product error occurred.	An Alibaba Cloud product error occurred.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-12-08

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 406
	delete Error Codes: 407
	delete Error Codes: 500
	delete Error Codes: 503
Output Parameters	The response structure of the API has changed.

2023-05-26

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 406
	delete Error Codes: 407
	delete Error Codes: 500
	delete Error Codes: 503
Output Parameters	The response structure of the API has changed.

2023-05-25

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 406
	delete Error Codes: 407
	delete Error Codes: 500
	delete Error Codes: 503
Output Parameters	The response structure of the API has changed.

2023-04-21

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 406
	delete Error Codes: 407
	delete Error Codes: 500
	delete Error Codes: 503
Output Parameters	The response structure of the API has changed.