ListClustersMeta - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the list of cluster metadata.

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:ListClustersMeta		All Resources ``	none	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 parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. Valid values: 1 to 50.	10
RequestId	string	The ID of the request.	DD517102-B314-4665-BDAC-A32DE7834D02
PageNumber	integer	The number of the returned page.	1
TotalCount	integer	The total number of returned entries.	1
Clusters	array<object>	The list of clusters.
ClusterInfoSimple	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 mode in which the cluster is 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
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 image tag of the operating system.	CentOS_7.2_64
AccountType	string	The server type of the account. 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 location where the cluster is 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
HasPlugin	boolean	Indicates whether the cluster uses a plug-in. Valid values: true false Default value: false	false
EhpcVersion	string	The version of E-HPC.	1.0.0

Examples

Sample success responses

JSONformat

{
  "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.
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.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-11-03	The Error code has changed. The response structure of the API has changed	View Change Details