Query cluster details by calling DescribeCluster - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries information about a specified cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:DescribeCluster

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
ClusterInfo	object	The cluster information.
Status	string	The cluster status. Valid values: uninit: Not initialized. creating: Being created. Init: Being initialized. running: Running. exception: Abnormal. releasing: Being released.	creating
VpcId	string	The VPC ID.	vpc-bp1pxkcvmmz53ki89****
KeyPairName	string	The key pair name.	test
EcsChargeType	string	The billing method of the cluster instances. Valid values: PostPaid: pay-as-you-go. PrePaid: subscription.	PostPaid
SecurityGroupId	string	The security group ID.	sg-bp1asugr34gzn****
SccClusterId	string	The SccCluster ID used by the cluster. This value is empty if the cluster does not use SCC instance types.	00b648b****
CreateTime	string	The time when the cluster was created. The time is in the ISO 8601 standard in the UTC time zone.	2020-12-24T03:18:23.000Z
AccountType	string	The account server type. Valid values: nis ldap	nis
VolumeProtocol	string	The network shared storage protocol. Valid values: nfs smb	nfs
Description	string	The cluster description.	cluster
VolumeId	string	The Apsara File Storage NAS (NAS) instance ID. Automatic creation of NAS instances is not supported.	008b64****
HaEnable	boolean	Indicates whether high availability is enabled. Note If high availability is enabled, each management role in the cluster uses two instances in primary/secondary mode.	false
BaseOsTag	string	The base image of the cluster.	CentOS_7.2_64
Name	string	The cluster name.	cluster
ImageId	string	The image ID.	centos_7_02_64_20G_alibase_20170818****
SchedulerType	string	The scheduling server type. Valid values: pbs slurm opengridscheduler deadline	pbs
SchedulerVersion	string	The scheduler software version.	18.1.1
DeployMode	string	The cluster deployment mode. Valid values: Standard: The domain account node, scheduling node, logon node, and compute nodes are deployed separately. Advanced: HA mode deployment. Simple: The domain account node and scheduling node are deployed on the same node. The logon node and compute nodes are deployed separately. Tiny: The domain account node, scheduling node, and logon node are deployed on the same node. The compute nodes are deployed separately.	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 image tag.	CentOS_7.2_64
VolumeMountpoint	string	The VPC mount target of the NAS file system. Automatic creation of NAS mount targets is not supported.	008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com
RemoteDirectory	string	The remote directory of the mounted shared storage.	NasMountpoint:/RemoteDirectory
RegionId	string	The region ID.	cn-hangzhou
VSwitchId	string	The vSwitch ID in the VPC. Only VPC networks are supported.	vsw-bp1e47optm9g58zcu****
ImageName	string	The image name.	test_for_Image
VolumeType	string	The type of network shared storage. Only NAS is supported.	NAS
Location	string	The cluster location. Valid values: OnPremise: hybrid cloud cluster. PublicCloud: public cloud cluster.	PublicCloud
Id	string	The instance ID.	i-bp15de54eet1c43f****
ClientVersion	string	The client version used by the cluster.	1.0.1
ZoneId	string	The zone ID.	cn-hangzhou-k
ResourceGroupId	string	The resource group ID.	rg-aek23szz5i2****
RamRoleName	string	The RAM role name of the instance.	AliyunEHPCFullAccess
RamNodeTypes	string	The details of node names that are authorized with instance roles.	["manager", "compute"]
Applications	object
ApplicationInfo	array<object>	The list of cluster applications, including the name and version of each application.
	object	The list of cluster applications, including the name and version of each application.
Tag	string	The application tag.	OpenMPI_1.8.7
Name	string	The application name.	openmpi
Version	string	The application version.	1.10
PostInstallScripts	object
PostInstallScriptInfo	array<object>	The list of post-installation scripts.
	object	The list of post-installation scripts.
Url	string	The download URL of the script.	example.com
Args	string	The script execution parameters.	bash file.sh
EcsInfo	object	The data structure that describes the number and specifications of ECS instances in the cluster.
Manager	object	The management node information.
InstanceType	string	The instance type of the management node.	ecs.n1.tiny
Count	integer	The number of management nodes.	1
Compute	object	The compute node information.
InstanceType	string	The ECS instance type of the compute node.	ecs.n1.tiny
Count	integer	The number of compute nodes.	1
Login	object	The logon node information.
InstanceType	string	The instance type of the logon node.	ecs.n1.tiny
Count	integer	The number of logon nodes.	1
ProxyMgr	object	The cloud proxy node information. This parameter is returned only when the cluster is a hybrid cloud cluster and the hybrid cloud proxy mode is enabled.
InstanceType	string	The instance type of the cloud proxy node.	ecs.n1.tiny
Count	integer	The number of cloud proxy nodes.	1
OnPremiseInfo	object
OnPremiseInfo	array<object>	The on-premises cluster management node information. This parameter is returned only when the cluster is a hybrid cloud cluster and the hybrid cloud proxy mode is enabled.
	object	The on-premises cluster management node information. This parameter is returned only when the cluster is a hybrid cloud cluster and the hybrid cloud proxy mode is enabled.
Type	string	The type of the on-premises cluster management node. Valid values: scheduler account account, scheduler	scheduler
HostName	string	The hostname of the on-premises cluster management node.	testecs
IP	string	The IP address of the on-premises cluster management node.	192.168..
AddOnsInfo	object
AddOnsInfo	array<object>	The custom component service information.
	object	The custom component service information.
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 service.	10000
Status	string	The running status of the custom component. Valid values: running stopped exception	running
URL	string	The access URL of the custom component service.	http://172.16.10.12:10000/
ClusterVersion	string	The cluster version.	1.0
WithoutAgent	integer	Indicates whether the Agent client is not installed.	false
Plugin	string	The plug-in pattern configuration. This parameter takes effect only when SchedulerType is set to custom. The value is a JSON format character string that contains the pluginMod, pluginLocalPath, and pluginOssPath parameters. The metric description is as follows: pluginMod: the plug-in pattern. The following two patterns are supported: oss: The plug-in is downloaded from OSS and extracted to the local pluginLocalPath folder. image: The plug-in is already placed in the pluginLocalPath folder by default. pluginLocalPath: the local path where the plug-in is stored. Use a shared storage folder for oss pattern and a non-shared storage folder for image pattern. pluginOssPath: the remote path of the plug-in on OSS. This parameter takes effect only when pluginMod is set to oss.	{\"pluginMod\":\"image\",\"pluginLocalPath\":\"/opt/plugin\"}
SchedulerPreInstall	integer	Indicates whether the scheduler is pre-installed in the business image. Valid values: true: Pre-installed. The scheduler installation process is skipped scale-out nodes are created or scaled out. false: Not pre-installed. The scheduler installation process is required scale-out nodes are created or scaled out.	true
Domain	string	The domain name of the on-premises cluster. This parameter is supported only when AccountType is set to ldap.	ldap
OpenldapPar	string	The parameters for connecting to the OpenLDAP server.	{ "LdapServerIp": "192.168.XX.XX", "BaseDn": "ehpctest", "FallbackHomeDir": "/home" }
WinAdPar	string	The parameters for connecting to the Windows AD server.	{ "AdUser": "Administrator", "AdUserPasswd": "xxxxxx", "AdDc": "ad-hybrid001.ehpcad.com", "AdIp": "192.168.XX.XX"}
Period	string	The duration for purchasing cluster nodes. The unit is specified by PeriodUnit. Valid values: If PriceUnit is set to Year: 1 to 3. If PriceUnit is set to Month: 1 to 9. If PriceUnit is set to Hour: 1. Default value: 1.	1
PeriodUnit	string	The unit of the duration for purchasing cluster nodes. Valid values: Year Month Hour Default value: Month.	Month
AutoRenewPeriod	string	The duration of each auto-renewal. This parameter takes effect when AutoRenew is set to true. If PeriodUnit is set to Week, valid values of AutoRenewPeriod are 1, 2, and 3. If PeriodUnit is set to Month, valid values of AutoRenewPeriod are 1, 2, 3, 6, and 12. Default value: 1.	1
AutoRenew	string	Indicates whether auto-renewal is enabled. This parameter takes effect only when EcsChargeType is set to PrePaid. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled. Default value: true.	false
ComputeSpotStrategy	string	The bidding policy for compute nodes. Valid values: NoSpot: The compute nodes are pay-as-you-go instances. SpotWithPriceLimit: The compute nodes are spot instances with a maximum hourly price. SpotAsPriceGo: The compute nodes are spot instances for which the system automatically bids based on the current market price.	NoSpot
ComputeSpotPriceLimit	string	The maximum hourly price for compute nodes. The value can have up to three decimal places. This parameter takes effect only when ComputeSpotStrategy is set to SpotWithPriceLimit.	0.56
Nodes	object
NodesInfo	array<object>	The list of on-premises cluster node information.
	object	The list of on-premises cluster node information.
Role	string	The role of the on-premises cluster node. Valid values: Manager: management node Login: logon node Compute: compute node	Compute
HostName	string	The hostname of the on-premises cluster node.	compute000
IpAddress	string	The IP address of the on-premises cluster node.	192.168.XX.XX
AccountType	string	The domain account service type of the on-premises cluster node. Valid values: nis ldap Default value: nis.	nis
Dir	string	The configuration directory of the on-premises cluster node.	/opt/sge/default/
SchedulerType	string	The scheduler type of the on-premises cluster node. Valid values: pbs slurm opengridscheduler deadline Default value: pbs.	pbs
InitialImage	object	The operating system image information.
OsTag	string	The operating system image supported by E-HPC.	CentOS_7.6_64
ImageOwnerAlias	string	The image type. 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

Success response

JSON format

{
  "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.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
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.
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.
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
406	NasError	NAS API request failed.	Failed to request the NAS interface.
406	AgentError	The agent service request failed.	The cluster-side command failed to run. %s
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.	Alibaba Cloud product error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.