ListClusters - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries all clusters of a user in each region.

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.

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

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:ListClusters	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterIds	array	No	The cluster IDs. You can specify up to 20 IDs.
	string	No	The cluster ID.	ehpc-cn-wulanchabu-llsu******
ClusterNames	array	No	The cluster names. You can specify up to 20 names.
	string	No	The cluster name.	slurm22.05.8-cluster-20240802
PageNumber	integer	No	The page number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 10 to 100. Default value: 10	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	2
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	string	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10
Clusters	array<object>	The list of clusters.
Cluster	object	The information about the cluster.
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 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
ClusterModifyTime	string	The time when the cluster was 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
ClusterCategory	string	The cluster type. Valid values: Standard Serverless	Standard
ClusterStatus	string	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. Releasing: The cluster is being released. stopping: The cluster is being stopped. stopped: The cluster is stopped. exception: The cluster has run into an exception. pending: The cluster is waiting to be configured.	running
ClusterVpcId	string	The ID of the virtual private cloud (VPC) used by the cluster.	vpc-m5efjevmclc0xdmys****
ClusterVSwitchId	string	The ID of the vSwitch used by the cluster.	vsw-f8za5p0mwzgdu3wgx****
SecurityGroupId	string	The ID of the security group 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	long	The maximum number of compute nodes that can be managed by the cluster.	500
MaxCoreCount	long	The maximum total number of vCPUs used by the compute nodes that can be managed by the cluster.	10000
DeletionProtection	boolean	Indicates whether deletion protection is enabled for the cluster. Valid values: true false	true
ResourceGroupId	string	The resource group ID.	rg-acfmxazb4ph****
Manager	object	The configurations of the cluster management node.
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 Elastic High Performance Computing (E-HPC) version.	2.0.0
Nodes	object	The node statistics 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 information about installed software in the cluster.
AdditionalPackageInfos	object	The information about the software.
Name	string	The software name.	gromacs
Version	string	The software version.	2024.1
Addons	array<object>	The information about the addons in the cluster.
AddonInfo	object	The information about the addon.
Name	string	The addon name.	Login
Version	string	The addon version.	1.0
Label	string	The addon label.
AddonId	string	The addon ID.	Login-1.0-W2g****
Description	string	The addon description.
Status	string	The addon state.	Running
ServicesSpec	array<object>	The information about the addon services.
ServiceInfo	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	float	The vCPU-hour usage of the cluster.	1000
ClusterMode	string	The deployment type of the cluster. Valid values: Integrated: public cloud Hybrid: hybrid cloud Custom: a custom cluster	Integrated
ClusterCredentials	array	The logon credential type of the cluster. Valid values: password: requires passwords for logons. keypair: requires key pairs for logons.
CredentialInfo	string	The credential type.	password

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "PageSize": 10,
  "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
        },
        "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,
          "Label": "",
          "AddonId": "Login-1.0-W2g****\n",
          "Description": "",
          "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
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
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

No change history