GetCluster API Reference for E-HPC Cluster Details - Elastic High Performance Computing

Query information about a specified E-HPC 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:GetCluster

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID.	ehpc-hz-FYUr32****

Response elements

Element	Type	Description	Example
	object	Returned parameter collection.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
ClusterId	string	The E-HPC cluster ID.	ehpc-hz-FYUr32****
ClusterName	string	The E-HPC cluster name.	slurm22.05.8-cluster-20240614
ClusterCategory	string	The cluster series. Valid values: Standard Serverless	Standard
MaxCount	string	The number of compute nodes the cluster can manage.	100
MaxCoreCount	string	The total number of cores of compute nodes the cluster can manage.	10000
DeleteProtection	string	Indicates whether delete protection is enabled for the cluster. Valid values: true: Enable delete protection. false: Do not enable delete protection.	true
ResourceGroupId	string	The resource group ID.	rg-acfmxazb4ph****
ClusterCreateTime	string	The cluster creation time. The time follows the ISO 8601 standard and is in UTC+0. The format is yyyy-MM-ddTHH:mmZ. For more information, see ISO 8601.	2024-08-06T12:43:01.000Z
ClusterModifyTime	string	The cluster modification time. The time follows the ISO 8601 standard and is in UTC+0. The format is yyyy-MM-ddTHH:mmZ. For more information, see ISO 8601.	2024-08-06T12:43:01.000Z
ClusterVpcId	string	The Virtual Private Cloud (VPC) ID used by the cluster.	vpc-uf6u3lk1pjy28eg*****
ClusterVSwitchId	string	The virtual switch ID used by the cluster.	vsw-bp1p2uugqsjppno******
SecurityGroupId	string	The security group ID.	sg-f8z9vb2zaezpkr69a21k
EhpcVersion	string	The E-HPC product version number.	2.0.0
ClientVersion	string	The E-HPC Util version used by the cluster.	2.0.31
ClusterStatus	string	The cluster status. Valid values: uninit: Installing creating: Creating initing: Initializing running: Running exception: Abnormal releasing: Releasing stopping: Stopping stopped: Stopped pending: Pending configuration	running
ClusterMode	string	The deployment type of the cluster. Valid values: Integrated: Public cloud Hybrid: Hybrid cloud Custom: Custom cluster	Integrated
Manager	object	The cluster control plane node configuration.
Scheduler	object	The scheduler service information.
Type	string	The scheduler type. Valid values: SLURM PBS OPENGRIDSCHEDULER LSF_PLUGIN PBS_PLUGIN	SLURM
Version	string	The scheduler version.	22.05.8
Status	string	The scheduler service status. Valid values: uninit: Installing initing: Initializing running: Running exception: Abnormal releasing: Releasing stopped: Stopped pending: Pending configuration	running
DirectoryService	object	The domain account service information.
Type	string	The domain account type.	nis
Version	string	The domain account version.	2.31
Status	string	The domain account service status. Valid values: uninit: Installing initing: Initializing running: Running exception: Abnormal releasing: Releasing stopped: Stopped pending: Pending configuration	running
DNS	object	The domain name resolution service configuration.
Type	string	The domain name resolution type.	nis
Version	string	The domain name resolution version.	2.31
Status	string	The domain name resolution service status. Valid values: uninit: Installing initing: Initializing running: Running exception: Abnormal releasing: Releasing stopped: Stopped pending: Pending configuration	running
ManagerNode	object	The control plane node configuration.
InstanceId	string	The control plane node instance ID.	i-bp1a170jgea1vl******
InstanceType	string	The control plane node instance type.	ecs.g6.4xlarge
InstanceChargeType	string	The billing method of the control plane node instance. Valid values: PostPaid: Pay-as-you-go PrePaid: Subscription	PostPaid
ExpiredTime	string	The expiration time of the control plane node.	2099-12-31T15:59Z
ImageId	string		aliyun_2_1903_x64_20G_alibase_20200324.vhd
PeriodUnit	string		Month
Period	integer		1
AutoRenew	boolean
AutoRenewPeriod	integer		Month
SpotStrategy	string		NoSpot
SpotPriceLimit	number		1
Duration	integer		1
EnableHt	boolean
SystemDisk	object
Category	string		cloud_ssd
Size	integer		40
Level	string		PL0
ClusterCustomConfiguration	object	The cluster post-processing script.
Script	string	The download URL of the post-processing script.	http://*****
Args	string	The runtime parameters of the post-installation script.	E-HPC cn-hangzhou
GrowInterval	integer	The interval for cluster auto scale-out.	2
IdleInterval	integer	The idle time of the cluster's compute nodes.	4
EnableScaleOut	boolean	Indicates whether auto scale-out is enabled for the cluster. Valid values: true: Enable false: Disable	true
EnableScaleIn	boolean	Indicates whether auto scale-in is enabled for the cluster. Valid values: true: Enable false: Disable	true
MonitorSpec	object	The cluster monitoring details.
EnableComputeLoadMonitor	boolean	Indicates whether the monitoring component for compute nodes is enabled for the cluster. Valid values: true: Enable false: Disable	true
SchedulerSpec	object	The cluster scheduling details.
EnableTopologyAwareness	boolean	Indicates whether the topology awareness feature is enabled for the cluster. Valid values: true: Enable false: Disable	true
EnablePowerSaving	boolean

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ClusterId": "ehpc-hz-FYUr32****",
  "ClusterName": "slurm22.05.8-cluster-20240614",
  "ClusterCategory": "Standard",
  "MaxCount": "100",
  "MaxCoreCount": "10000",
  "DeleteProtection": "true",
  "ResourceGroupId": "rg-acfmxazb4ph****",
  "ClusterCreateTime": "2024-08-06T12:43:01.000Z\n",
  "ClusterModifyTime": "2024-08-06T12:43:01.000Z\n",
  "ClusterVpcId": "vpc-uf6u3lk1pjy28eg*****",
  "ClusterVSwitchId": "vsw-bp1p2uugqsjppno******",
  "SecurityGroupId": "sg-f8z9vb2zaezpkr69a21k",
  "EhpcVersion": "2.0.0",
  "ClientVersion": "2.0.31",
  "ClusterStatus": "running",
  "ClusterMode": "Integrated",
  "Manager": {
    "Scheduler": {
      "Type": "SLURM",
      "Version": "22.05.8",
      "Status": "running"
    },
    "DirectoryService": {
      "Type": "nis",
      "Version": "2.31",
      "Status": "running"
    },
    "DNS": {
      "Type": "nis",
      "Version": "2.31",
      "Status": "running"
    },
    "ManagerNode": {
      "InstanceId": "i-bp1a170jgea1vl******",
      "InstanceType": "ecs.g6.4xlarge",
      "InstanceChargeType": "PostPaid",
      "ExpiredTime": "2099-12-31T15:59Z",
      "ImageId": "aliyun_2_1903_x64_20G_alibase_20200324.vhd",
      "PeriodUnit": "Month",
      "Period": 1,
      "AutoRenew": false,
      "AutoRenewPeriod": 0,
      "SpotStrategy": "NoSpot",
      "SpotPriceLimit": 1,
      "Duration": 1,
      "EnableHt": false,
      "SystemDisk": {
        "Category": "cloud_ssd",
        "Size": 40,
        "Level": "PL0"
      }
    }
  },
  "ClusterCustomConfiguration": {
    "Script": "http://*****\n",
    "Args": "E-HPC cn-hangzhou\n"
  },
  "GrowInterval": 2,
  "IdleInterval": 4,
  "EnableScaleOut": true,
  "EnableScaleIn": true,
  "MonitorSpec": {
    "EnableComputeLoadMonitor": true
  },
  "SchedulerSpec": {
    "EnableTopologyAwareness": true,
    "EnablePowerSaving": false
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.