Queries the list of cluster metadata.

Debugging

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 value: 10

Response parameters

Parameter Type Example Description
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.

PageNumber Integer 1

The number of the returned page.

TotalCount Integer 1

The total number of returned entries.

Clusters Array of ClusterInfoSimple

The list of clusters.

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

The ID of the virtual private cloud (VPC).

SchedulerType String pbs

The type of the scheduler. Valid values:

  • pbs
  • slurm
  • opengridscheduler
  • deadline
DeployMode String Standard

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.
IsComputeEss Boolean false

Indicates whether a scaling group is enabled. Valid values:

  • true: A scaling group is enabled.
  • false: No scaling group is enabled.
OsTag String CentOS_7.2_64

The image tag of the operating system.

AccountType String nis

The server type of the account. Valid values:

  • nis
  • ldap
Description String clusterdescription

The description of the cluster.

Name String cluster1

The name of the cluster.

Id String ehpc-hz-jeJki6****

The ID of the cluster.

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.
ClientVersion String 1.0.64

The version of the client.

HasPlugin Boolean false

Indicates whether the cluster uses a plug-in. Valid values:

  • true
  • false

Default value: false

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListClustersMeta
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListClustersMetaResponse>
    <PageSize>10</PageSize>
    <RequestId>DD517102-B314-4665-BDAC-A32DE7834D02</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Clusters>
        <Status>running</Status>
        <VpcId>vpc-b3f3edefefeep0760yju****</VpcId>
        <SchedulerType>pbs</SchedulerType>
        <DeployMode>Standard</DeployMode>
        <IsComputeEss>false</IsComputeEss>
        <OsTag>CentOS_7.2_64</OsTag>
        <AccountType>nis</AccountType>
        <Description>clusterdescription</Description>
        <Name>cluster1</Name>
        <Id>ehpc-hz-jeJki6****</Id>
        <Location>PublicCloud</Location>
        <ClientVersion>1.0.64</ClientVersion>
        <HasPlugin>false</HasPlugin>
    </Clusters>
</ListClustersMetaResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "DD517102-B314-4665-BDAC-A32DE7834D02",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Clusters" : [ {
    "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
  } ]
}

Error codes

HttpCode Error code Error message Description
400 InvalidParams The specified parameter %s is invalid. The error message returned because the following parameter is invalid: %s.
406 EcsError An error occurred while calling the ECS API operation. The error message returned because the ECS API call has failed.
406 AgentError The agent service request failed. The error message returned because the proxy request has failed.
406 DbError A database service error occurred. The error message returned because the database request has failed.
406 AliyunError An Alibaba Cloud product error occurred. The error message returned because the operation has failed to call another Alibaba Cloud service.
407 NotAuthorized You are not authorized by RAM for this request. The error message returned because you are not authorized by RAM for this request.
500 UnknownError An unknown error occurred. The error message returned because an unknown error has occurred. Try again later. If the error persists, submit a ticket.
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The service is temporarily unavailable.

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