Call the ListClustersMeta API to query cluster metadata - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries cluster metadata in a paginated list.

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

*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. Valid values: 1 to 50.	10
RequestId	string	The request ID.	DD517102-B314-4665-BDAC-A32DE7834D02
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of returned entries.	1
Clusters	object
ClusterInfoSimple	array<object>	The list of clusters.
	object
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
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-b3f3edefefeep0760yju****
SchedulerType	string	The type of the scheduler. Valid values: pbs slurm opengridscheduler deadline	pbs
DeployMode	string	The deployment mode of the cluster. 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
IsComputeEss	boolean	Indicates whether a scaling group is enabled. Valid values: true: A scaling group is enabled. false: No scaling group is enabled.	false
OsTag	string	The OS image tag.	CentOS_7.2_64
AccountType	string	The account type. Valid values: nis ldap	nis
Description	string	The description of the cluster.	clusterdescription
Name	string	The name of the cluster.	cluster1
Id	string	The ID of the cluster.	ehpc-hz-jeJki6****
Location	string	The deployment location of the cluster. Valid values: OnPremise: The cluster is deployed on a hybrid cloud. PublicCloud: The cluster is deployed on a public cloud.	PublicCloud
ClientVersion	string	The client version.	1.0.64
HasPlugin	boolean	Indicates whether the cluster uses a plug-in. Valid values: true false Default value: false	false
EhpcVersion	string	The E-HPC version.	1.0.0

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "DD517102-B314-4665-BDAC-A32DE7834D02",
  "PageNumber": 1,
  "TotalCount": 1,
  "Clusters": {
    "ClusterInfoSimple": [
      {
        "Status": "running",
        "VpcId": "vpc-b3f3edefefeep0760yju****",
        "SchedulerType": "pbs",
        "DeployMode": "Standard",
        "IsComputeEss": false,
        "OsTag": "CentOS_7.2_64",
        "AccountType": "nis",
        "Description": "clusterdescription",
        "Name": "cluster1",
        "Id": "ehpc-hz-jeJki6****",
        "Location": "PublicCloud",
        "ClientVersion": "1.0.64",
        "HasPlugin": false,
        "EhpcVersion": "1.0.0"
      }
    ]
  }
}

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.
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	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
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
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.