Query E-HPC Clusters Across Regions via ListClusters API-E - HPC - Alibaba Cloud - Elastic High Performance Computing

Queries the list of all clusters in each region under your account.

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:ListClusters

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterIds	array	No	The IDs of the clusters to query. Valid values of N: 0 to 20.
	string	No	The cluster ID.	ehpc-cn-wulanchabu-llsu******
ClusterNames	array	No	The names of the clusters to query. Valid values of N: 0 to 20.
	string	No	The cluster name.	slurm22.05.8-cluster-20240802
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Settings the number of rows per page for paging. Valid values: 10 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries in the list.	2
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	string	The current page number.	1
PageSize	integer	The number of entries on the current page.	10
EhpcVersionStatistics	object
V1Count	integer
V2Count	integer
Clusters	array<object>	The cluster details.
	array<object>	The cluster information.
ClusterId	string	The cluster ID.	ehpc-hz-VMKe******
ClusterName	string	The cluster name.	slurm22.05.8-cluster-20240227
ClusterDescription	string	The cluster description.	Demo
ClusterCreateTime	string	The time when the cluster was created. The time is displayed in UTC+0 in the ISO 8601 standard format of yyyy-MM-ddTHH:mmZ. For more information, see ISO 8601.	2024-08-06T12:43:01.000Z
ClusterModifyTime	string	The time when the cluster was last modified. The time is displayed in UTC+0 in the ISO 8601 standard format of yyyy-MM-ddTHH:mmZ. For more information, see ISO 8601.	2024-08-06T12:43:01.000Z
ClusterCategory	string	The cluster edition. Valid values: Standard Serverless	Standard
ClusterStatus	string	The cluster status. Valid values: uninit: installing. creating: being created. initing: being initialized. running: running. releasing: being released. stopping: being stopped. stopped: stopped. exception: abnormal. pending: pending configuration.	running
ClusterVpcId	string	The VPC ID used by the cluster.	vpc-m5efjevmclc0xdmys****
ClusterVSwitchId	string	The vSwitch ID used by the cluster.	vsw-f8za5p0mwzgdu3wgx****
SecurityGroupId	string	The security group ID used by the cluster.	sg-bp13n61xsydodfyg****
ClusterCustomConfiguration	object	The post-processing script used by the cluster.
Script	string	The link to the post-processing script.	https://xxxxx
Args	string	The parameters of the post-processing script.	demo
MaxCount	integer	The maximum number of compute nodes that the cluster can manage.	500
MaxCoreCount	integer	The maximum total number of vCPUs of compute nodes that the cluster can manage.	10000
DeletionProtection	boolean	Indicates whether deletion protection is enabled for the cluster. Valid values: true: Deletion protection is enabled. false: Deletion protection is not enabled.	true
ResourceGroupId	string	The resource group ID.	rg-acfmxazb4ph****
Manager	object	The management node configuration of the cluster.
Scheduler	object	The configurations of the scheduler service.
Type	string	The scheduler type.	SLURM
Version	string	The scheduler version.	22.05.8
DirectoryService	object	The configurations of the directory service.
Type	string	The type of the domain account.	NIS
Version	string	The version of the domain account service.	2.31
DNS	object	The configurations of the domain name resolution service.
Type	string	The resolution type.	NIS
Version	string	The version of the domain name resolution service.	2.31
EhpcVersion	string	The version of the E-HPC cluster.	2.0.0
Nodes	object	The node count information of the cluster.
RunningCounts	integer	The number of running compute nodes.	1
AbnormalCounts	integer	The number of malfunctioning compute nodes.	0
CreatingCounts	integer	The number of compute nodes that are being created.	0
Users	object	The user attribute information of the cluster.
SudoCounts	integer	The number of administrators.	2
NormalCounts	integer	The number of ordinary users.	2
AdditionalPackages	array<object>	The software installed on the cluster.
	object	The software details.
Name	string	The software name.	gromacs
Version	string	The software version.	2024.1
Addons	array<object>	The custom service component information of the cluster.
	array<object>	The custom service component details.
Name	string	The addon name.	Login
Version	string	The addon version.	1.0
Label	string	The addon label.	Logon node
AddonId	string	The addon ID.	Login-1.0-W2g****
Description	string	The addon description.	Logon node, mainly used for connecting to the E-HPC cluster environment and submitting user tasks.
Status	string	The addon state.	Running
ServicesSpec	array<object>	The information about the addon services.
	object	The information about the service.
ServiceName	string	The service name.	Web Portal
ServiceAccessType	string	The service access type.	URL
ServiceAccessUrl	string	The service access URL.	https://47.96.xx.xx:12008
ResourcesSpec	object	The resource configurations of the addon.
EipInstanceId	string	The Elastic IP Address (EIP) ID.	eip-bp1vi9124tbx1g3kr****
EcsInstanceId	string	The instance ID.	i-bp1bg85d2q6laic8****
ClusterUsedCoreTime	number	The core-hours consumed by the cluster.	1000
ClusterMode	string	The deployment type of the cluster. Valid values: Integrated: public cloud Hybrid: hybrid cloud Custom: custom cluster	Integrated
ClusterCredentials	array	The logon credential types of the cluster. Valid values: password: uses a password to log on to the cluster. keypair: uses a key pair to log on to the cluster.
	string	The credential type.	password

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": "1",
  "PageSize": 10,
  "EhpcVersionStatistics": {
    "V1Count": 0,
    "V2Count": 0
  },
  "Clusters": [
    {
      "ClusterId": "ehpc-hz-VMKe******",
      "ClusterName": "slurm22.05.8-cluster-20240227",
      "ClusterDescription": "Demo",
      "ClusterCreateTime": "2024-08-06T12:43:01.000Z",
      "ClusterModifyTime": "2024-08-06T12:43:01.000Z",
      "ClusterCategory": "Standard",
      "ClusterStatus": "running",
      "ClusterVpcId": "vpc-m5efjevmclc0xdmys****\n",
      "ClusterVSwitchId": "vsw-f8za5p0mwzgdu3wgx****\n",
      "SecurityGroupId": "sg-bp13n61xsydodfyg****\n",
      "ClusterCustomConfiguration": {
        "Script": "https://xxxxx",
        "Args": "demo"
      },
      "MaxCount": 500,
      "MaxCoreCount": 10000,
      "DeletionProtection": true,
      "ResourceGroupId": "rg-acfmxazb4ph****",
      "Manager": {
        "Scheduler": {
          "Type": "SLURM",
          "Version": "22.05.8\n"
        },
        "DirectoryService": {
          "Type": "NIS",
          "Version": "2.31\n"
        },
        "DNS": {
          "Type": "NIS",
          "Version": "2.31"
        }
      },
      "EhpcVersion": "2.0.0",
      "Nodes": {
        "RunningCounts": 1,
        "AbnormalCounts": 0,
        "CreatingCounts": 0
      },
      "Users": {
        "SudoCounts": 2,
        "NormalCounts": 2
      },
      "AdditionalPackages": [
        {
          "Name": "gromacs",
          "Version": "2024.1"
        }
      ],
      "Addons": [
        {
          "Name": "Login",
          "Version": "1.0",
          "Label": "Logon node",
          "AddonId": "Login-1.0-W2g****\n",
          "Description": "Logon node, mainly used for connecting to the E-HPC cluster environment and submitting user tasks.",
          "Status": "Running\n",
          "ServicesSpec": [
            {
              "ServiceName": "Web Portal\n",
              "ServiceAccessType": "URL",
              "ServiceAccessUrl": "https://47.96.xx.xx:12008\n"
            }
          ],
          "ResourcesSpec": {
            "EipInstanceId": "eip-bp1vi9124tbx1g3kr****\n",
            "EcsInstanceId": "i-bp1bg85d2q6laic8****"
          }
        }
      ],
      "ClusterUsedCoreTime": 1000,
      "ClusterMode": "Integrated",
      "ClusterCredentials": [
        "password"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.
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.