Use ListClusters to query all E-HPC clusters - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries all Elastic High Performance Computing (E-HPC) clusters of the current account in each region.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Pages start from page 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	The number of the returned page.	1
TotalCount	integer	The total number of returned entries.	1
Clusters	object
ClusterInfoSimple	array<object>	The list of clusters.
	array<object>
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-b3f3edefefeep0760yju****
Status	string	The status of the cluster. Valid values: uninit: The cluster is not initialized. creating: The cluster is being created. init: The cluster is being initialized. running: The cluster is running. exception: The cluster encounters an exception. releasing: The cluster is being released.	running
CreateTime	string	The time when the instance was created.	2020-10-30T07:39:20.000Z
IsComputeEss	boolean	Indicates whether a scaling group was enabled. Valid values: true: A scaling group is enabled. false: No scaling group is enabled.	false
ComputeSpotStrategy	string	The bidding method of the compute nodes. Valid values: NoSpot: The instances of the compute node are pay-as-you-go instances. SpotWithPriceLimit: The instances of the compute node are preemptible instances. These types of instances have a specified maximum hourly price. SpotAsPriceGo: The instances of the compute node are preemptible instances. The price of these instances is based on the current market price.	NoSpot
AccountType	string	The server type of the account. Valid values: nis ldap	nis
Count	integer	The number of compute nodes in the cluster.	3
EhpcVersion	string	The version of E-HPC.	1.0.0
Description	string	The description of the cluster.	clusterdescription
BaseOsTag	string	The operating system tag of the base image. The tag was used only by the management node.	CentOS_7.2_64
Name	string	The name of the cluster.	test
ImageId	string	The ID of the image.	wi_1607_x64_dtc_zh_40G_alibase****
ComputeSpotPriceLimit	number	The maximum hourly price for the ECS instance under the compute node. The return value can be accurate to three decimal places.	0.034
SchedulerType	string	The type of the scheduler. Valid values: pbs slurm opengridscheduler deadline	pbs
DeployMode	string	The mode in which the cluster was deployed. Valid values: Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed. Advanced: Two high availability (HA) account nodes, two HA scheduler nodes, one logon node, and multiple compute nodes are separately deployed. Simple: A management node, a logon node, and multiple compute nodes are deployed. The management node consists of an account node and a scheduling node. The logon node and compute nodes are separately deployed. Tiny: A management node and multiple compute nodes are deployed. The management node consists of an account node, a scheduling node, and a logon node. The compute nodes are separately deployed.	Standard
NodeSuffix	string	The suffix of the node.	name
ImageOwnerAlias	string	The type of the image. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image	system
OsTag	string	The operating system tag of the image.	CentOS_7.2_64
NodePrefix	string	The prefix of the node.	test
InstanceType	string	The instance type of the compute nodes.	ecs.n1.tiny
RegionId	string	The ID of the region.	cn-hangzhou
InstanceChargeType	string	The billing method of the nodes in the cluster. Valid values: PostPaid: pay-as-you-go PrePaid: subscription	PostPaid
VSwitchId	string	The ID of the vSwitch.	vsw-bp1lfcjbfb099rrjn****
ZoneId	string	The ID of the zone.	cn-hangzhou-c
LoginNodes	string	The list of logon nodes.	{"Id": "i-bp13x4is8pvdhws7e****"}
Id	string	The ID of the cluster.	ehpc-hz-jeJki6****
Location	string	The location where the cluster was deployed. Valid values: OnPremise: The cluster is deployed on a hybrid cloud. PublicCloud: The cluster is deployed on a public cloud.	PublicCloud
ClientVersion	string	The version of the client.	1.0.64
ResourceGroupId	string	The resource group ID.You can call the ListResourceGroups operation to query the IDs of resource groups.	rg-acfmxazb4ph****
Managers	object	The list of management nodes.
OperatingCount	integer	The number of nodes that are being used in the queue. This includes those that are being initialized, installed, or released.	1
ExceptionCount	integer	The number of abnormal nodes.	0
StoppedCount	integer	The number of stopped nodes.	0
Total	integer	The total number of management nodes.	2
NormalCount	integer	The number of normal nodes.	1
Computes	object	The information about compute nodes.
OperatingCount	integer	The number of nodes that are being used in the queue. This includes those that are being initialized, installed, or released.	1
ExceptionCount	integer	The number of abnormal nodes.	0
StoppedCount	integer	The number of stopped nodes.	0
Total	integer	The total number of nodes.	2
NormalCount	integer	The number of normal nodes.	1
TotalResources	object	The statistics of all resources in the cluster.
Gpu	integer	The number of GPU cards. Unit: cards.	0
Cpu	integer	The number of CPU cores. Unit: cores.	1
Memory	integer	The memory size. Unit: MiB.	1024
UsedResources	object	The number of consumed resources in the cluster.
Gpu	integer	The number of GPU cards. Unit: cards.	0
Cpu	integer	The number of CPU cores. Unit: cores.	1
Memory	integer	The memory size. Unit: MiB.	1024
HasPlugin	boolean	Indicates whether plug-ins were used in the cluster. Valid values: true: Plug-ins are used. false: Plug-ins are not used. Default value: false	false

Examples

Success response

JSON format

{
  "PageSize": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "TotalCount": 1,
  "Clusters": {
    "ClusterInfoSimple": [
      {
        "VpcId": "vpc-b3f3edefefeep0760yju****",
        "Status": "running",
        "CreateTime": "2020-10-30T07:39:20.000Z",
        "IsComputeEss": false,
        "ComputeSpotStrategy": "NoSpot",
        "AccountType": "nis",
        "Count": 3,
        "EhpcVersion": "1.0.0",
        "Description": "clusterdescription",
        "BaseOsTag": "CentOS_7.2_64",
        "Name": "test",
        "ImageId": "wi_1607_x64_dtc_zh_40G_alibase****",
        "ComputeSpotPriceLimit": 0.034,
        "SchedulerType": "pbs",
        "DeployMode": "Standard",
        "NodeSuffix": "name",
        "ImageOwnerAlias": "system",
        "OsTag": "CentOS_7.2_64",
        "NodePrefix": "test",
        "InstanceType": "ecs.n1.tiny",
        "RegionId": "cn-hangzhou",
        "InstanceChargeType": "PostPaid",
        "VSwitchId": "vsw-bp1lfcjbfb099rrjn****",
        "ZoneId": "cn-hangzhou-c",
        "LoginNodes": "{\"Id\": \"i-bp13x4is8pvdhws7e****\"}",
        "Id": "ehpc-hz-jeJki6****",
        "Location": "PublicCloud",
        "ClientVersion": "1.0.64",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "Managers": {
          "OperatingCount": 1,
          "ExceptionCount": 0,
          "StoppedCount": 0,
          "Total": 2,
          "NormalCount": 1
        },
        "Computes": {
          "OperatingCount": 1,
          "ExceptionCount": 0,
          "StoppedCount": 0,
          "Total": 2,
          "NormalCount": 1
        },
        "TotalResources": {
          "Gpu": 0,
          "Cpu": 1,
          "Memory": 1024
        },
        "UsedResources": {
          "Gpu": 0,
          "Cpu": 1,
          "Memory": 1024
        },
        "HasPlugin": false
      }
    ]
  }
}

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	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	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	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
407	EntityNotExist.Role	The role does not exist.	The role does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.