All Products
Search
Document Center

Elastic High Performance Computing:GetCluster

Last Updated:Jan 14, 2026
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries information about an Elastic High Performance Computing (E-HPC) cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:GetClusterget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringNo

The cluster ID.

ehpc-hz-FYUr32****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
ClusterIdstring

The cluster ID.

ehpc-hz-FYUr32****
ClusterNamestring

The cluster name.

slurm22.05.8-cluster-20240614
ClusterCategorystring

The cluster type. Valid values:

  • Standard
  • Serverless
Standard
MaxCountstring

The maximum number of compute nodes that the cluster can manage.

100
MaxCoreCountstring

The maximum total number of vCPUs that can be used by all compute nodes managed by the cluster.

10000
DeleteProtectionstring

Indicates whether deletion protection is enabled for the cluster. Valid values:

  • true
  • false
true
ResourceGroupIdstring

The resource group ID.

rg-acfmxazb4ph****
ClusterCreateTimestring

The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see ISO 8601.

2024-08-06T12:43:01.000Z
ClusterModifyTimestring

The time when the cluster was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see ISO 8601.

2024-08-06T12:43:01.000Z
ClusterVpcIdstring

The ID of the virtual private cloud (VPC) used by the cluster.

vpc-uf6u3lk1pjy28eg*****
ClusterVSwitchIdstring

The ID of the vSwitch used by the cluster.

vsw-bp1p2uugqsjppno******
SecurityGroupIdstring

The security group ID.

sg-f8z9vb2zaezpkr69a21k
EhpcVersionstring

The E-HPC version.

2.0.0
ClientVersionstring

The E-HPC Util version.

2.0.31
ClusterStatusstring

The cluster state. Valid values:

  • uninit: The cluster is being installed.
  • creating: The cluster is being created.
  • initing: The cluster is being initialized.
  • running: The cluster is running.
  • exception: The cluster has run into an exception.
  • raleasing: The cluster is being released.
  • stopping: The cluster is being stopped.
  • stopped: The cluster is stopped.
  • pending: The cluster is waiting to be configured.
running
ClusterModestring

The deployment type of the cluster. Valid values:

  • Integrated: The cluster is deployed on a public cloud.
  • Hybrid: The cluster is deployed on a hybrid cloud.
  • Custom: The cluster is a custom cluster.
Integrated
Managerobject

The management node configurations.

Schedulerobject

The information about the scheduler.

Typestring

The scheduler type. Valid values:

  • SLURM
  • PBS
  • OPENGRIDSCHEDULER
  • LSF_PLUGIN
  • PBS_PLUGIN
SLURM
Versionstring

The scheduler version.

22.05.8
Statusstring

The scheduler state. Valid values:

  • uninit: The scheduler is being installed.
  • initing: The scheduler is being initialized.
  • running: The scheduler is running.
  • exception: The scheduler has run into an exception.
  • releasing: The scheduler is being released.
  • stopped: The scheduler is stopped.
  • pending: The scheduler is waiting to be configured.
running
DirectoryServiceobject

The information about the domain account service.

Typestring

The type of the domain account.

nis
Versionstring

The version of the domain account service.

2.31
Statusstring

The state of the domain account service. Valid values:

  • uninit: The service is being installed.
  • initing: The service is being initialized.
  • running: The service is running.
  • exception: The service has run into an exception.
  • releasing: The service is being released.
  • stopped: The service is stopped.
  • pending: The service is waiting to be configured.
running
DNSobject

The configurations of the domain name resolution service.

Typestring

The resolution type.

nis
Versionstring

The version of the resolution service.

2.31
Statusstring

The state of the domain name resolution service. Valid values:

  • uninit: The service is being installed.
  • initing: The service is being initialized.
  • running: The service is running.
  • exception: The service has run into an exception.
  • releasing: The service is being released.
  • stopped: The service is stopped.
  • pending: The service is waiting to be configured.
running
ManagerNodeobject

The configurations of the management node.

InstanceIdstring

The instance ID of the management node.

i-bp1a170jgea1vl******
InstanceTypestring

The instance type of the management node.

ecs.g6.4xlarge
InstanceChargeTypestring

The instance billing method of the management node. Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription
PostPaid
ExpiredTimestring

The expiration time of the management node.

2099-12-31T15:59Z
ClusterCustomConfigurationobject

The post-processing script of the cluster.

Scriptstring

The URL that is used to download the post-processing script.

http://*****
Argsstring

The arguments that are used to run the script after the scrip is installed.

E-HPC cn-hangzhou
GrowIntervalinteger

The interval at which the cluster is automatically scaled out.

2
IdleIntervalinteger

The idle duration of the compute nodes allowed by the cluster.

4
EnableScaleOutboolean

Indicates whether automatic scale-out is enabled for the cluster. Valid values:

  • true
  • false
true
EnableScaleInboolean

Indicates whether automatic scale-in is enabled for the cluster. Valid values:

  • true
  • false
true
MonitorSpecobject

The monitoring details of the cluster.

EnableComputeLoadMonitorboolean

Indicates whether the monitoring component of compute nodes is enabled for the cluster. Valid values:

  • true
  • false
true
SchedulerSpecobject

The scheduler specifications of the cluster.

EnableTopologyAwarenessboolean

Indicates whether the topology awareness feature is enabled for the cluster. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "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"
    }
  },
  "ClusterCustomConfiguration": {
    "Script": "http://*****\n",
    "Args": "E-HPC cn-hangzhou\n"
  },
  "GrowInterval": 2,
  "IdleInterval": 4,
  "EnableScaleOut": true,
  "EnableScaleIn": true,
  "MonitorSpec": {
    "EnableComputeLoadMonitor": true
  },
  "SchedulerSpec": {
    "EnableTopologyAwareness": true
  }
}

Error codes

HTTP status codeError codeError messageDescription
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe 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 timeSummary of changesOperation
2025-12-30The Error code has changed. The response structure of the API has changedView Change Details
2025-12-15The Error code has changed. The response structure of the API has changedView Change Details
2025-01-06The Error code has changed. The response structure of the API has changedView Change Details
2024-12-05The Error code has changed. The response structure of the API has changedView Change Details