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

Queries the list of clusters in the current region for the account by calling ListClusters.

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 page number to display. Minimum value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries on the current page.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	The current page number.	1
TotalCount	integer	The total number of entries in the list.	1
Clusters	object
ClusterInfoSimple	array<object>	The cluster details.
	array<object>
VpcId	string	VPC ID。	vpc-b3f3edefefeep0760yju****
Status	string	The cluster status. Valid values: uninit: not initialized creating: being created init: being initialized running: running exception: abnormal releasing: being released	running
CreateTime	string	The time when the cluster was created. The time is in the ISO 8601 standard in the UTC time zone.	2020-10-30T07:39:20.000Z
IsComputeEss	boolean	Indicates whether elastic scaling is enabled. Valid values: true: Enabled. false: Disabled.	false
ComputeSpotStrategy	string	The bidding strategy for compute nodes. Valid values: NoSpot: The instance is a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is a spot instance with a maximum price limit. SpotAsPriceGo: The system automatically bids at 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 Elastic High Performance Computing (E-HPC) version.	1.0.0
Description	string	The cluster description.	clusterdescription
BaseOsTag	string	The base image operating system tag, which is used only for management nodes.	CentOS_7.2_64
Name	string	The cluster name.	test
ImageId	string	The image ID.	wi_1607_x64_dtc_zh_40G_alibase****
ComputeSpotPriceLimit	number	The maximum hourly price for the ECS instance on the compute node. The return value is rounded to three decimal places.	0.034
SchedulerType	string	The scheduling server type. Valid values: pbs slurm opengridscheduler deadline	pbs
DeployMode	string	The cluster deployment mode. Valid values: Standard: The domain scheduling node, scheduler, logon node, and compute nodes are deployed separately. Advanced: High-availability (HA) mode deployment. Simple: The domain scheduling node and scheduler are deployed on the same node. The logon node and compute nodes are deployed separately. Tiny: The domain scheduling node, scheduler, and logon node are deployed on the same node. The compute nodes are deployed separately.	Standard
NodeSuffix	string	The hostname suffix.	name
ImageOwnerAlias	string	The image type. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image	system
OsTag	string	The operating system image tag.	CentOS_7.2_64
NodePrefix	string	The hostname prefix.	test
InstanceType	string	The instance type of the compute nodes.	ecs.n1.tiny
RegionId	string	The region ID.	cn-hangzhou
InstanceChargeType	string	The billing method of the cluster instances. Valid values: PostPaid: pay-as-you-go PrePaid: subscription	PostPaid
VSwitchId	string	The vSwitch ID.	vsw-bp1lfcjbfb099rrjn****
ZoneId	string	The zone ID.	cn-hangzhou-c
LoginNodes	string	The list of logon nodes.	{"Id": "i-bp13x4is8pvdhws7e****"}
Id	string	The cluster ID.	ehpc-hz-jeJki6****
Location	string	The cluster location. Valid values: OnPremise: Hybrid cloud cluster. PublicCloud: Public cloud cluster.	PublicCloud
ClientVersion	string	The cluster client version.	1.0.64
ResourceGroupId	string	The resource group ID. You can call ListResourceGroups to query the resource group ID.	rg-acfmxazb4ph****
Managers	object	The management node information.
OperatingCount	integer	The number of nodes on which operations are in progress, including nodes in the initializing, installing, or releasing state.	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 compute node information.
OperatingCount	integer	The number of nodes on which operations are in progress, including nodes in the initializing, installing, or releasing state.	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 total cluster resources.
Gpu	integer	The GPU resources. Unit: cards.	0
Cpu	integer	The CPU resources. Unit: cores.	1
Memory	integer	The memory size. Unit: MiB.	1024
UsedResources	object	The used cluster resources.
Gpu	integer	The GPU resources. Unit: cards.	0
Cpu	integer	The CPU resources. Unit: cores.	1
Memory	integer	The memory size. Unit: MiB.	1024
HasPlugin	boolean	Indicates whether the cluster uses a plugin. Valid values: true: Yes. false: No. 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.