Queries the list of cluster metadata.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListClustersMeta

The operation that you want to perform. Set the value to ListClustersMeta.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50.

Default: 10.

Response parameters

Parameter Type Example Description
TotalCount Integer 1

The total number of entries.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page. Valid values: 1 to 50.

RequestId String DD517102-B314-4665-BDAC-A32DE7834D02

The ID of the request.

Clusters Array of ClusterInfoSimple

The details about clusters.

AccountType String nis

The server type of the account. Valid values:

  • nis
  • ldap
ClientVersion String 1.0.64

The version of the cluster client.

DeployMode String Standard

The mode in which the cluster is deployed. Valid values:

  • Standard: An account node, a scheduler node, a login node, and multiple compute nodes are separately deployed.
  • Advanced: Two high availability (HA) account nodes, two HA scheduler nodes, one login node, and multiple compute nodes are separately deployed.
  • Simple: A cluster management node, a login node, and multiple compute nodes are deployed. The account management and job scheduler services are deployed on the cluster management node.
  • Tiny: The account management, job scheduler, and login services are deployed on a single node. Multiple compute nodes are separately deployed.
Description String clusterdescription

The description of the cluster.

Id String ehpc-hz-jeJki6****

The ID of the cluster.

IsComputeEss Boolean false

Indicates whether the scaling group is enabled. Valid values:

  • true: The scaling group is enabled.
  • false: The scaling group is disabled.
Location String PublicCloud

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.
Name String cluster1

The name of the cluster.

OsTag String CentOS_7.2_64

The image tag of the operating system.

SchedulerType String pbs

The type of the scheduler. Valid values:

  • pbs
  • slurm
  • opengridscheduler
  • deadline
Status String running

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 node encounters an exception.
  • releasing: The cluster is being released.
VpcId String vpc-b3f3edefefeep0760yju****

The ID of the virtual private cloud (VPC) to which the instance belongs.


Sample requests

&<Common request parameters>

Sample responses

XML format


JSON format

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

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.