Queries the list of clusters in all regions within an account.

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 ListClusters

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

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 1

The number of entries returned per page.

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The total number of returned entries.

Clusters Array of ClusterInfoSimple

The list of clusters.

ClusterInfoSimple
VpcId String vpc-b3f3edefefeep0760yju****

The ID of the virtual private cloud (VPC).

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.
CreateTime String 2020-10-30T07:39:20.000Z

The time when the cluster was created.

IsComputeEss Boolean false

Indicates whether a scaling group is enabled. Valid values:

  • true: A scaling group is enabled.
  • false: No scaling group is enabled.
ComputeSpotStrategy String NoSpot

The bidding method of the compute nodes. Valid values:

  • NoSpot: The instances of the compute node are pay-as-you-go instances.
  • SpotWithPriceLimit: The instances of the compute node are preemptible instances. These types of instances have a specified maximum hourly price.
  • SpotAsPriceGo: The instances of the compute node are preemptible instances. The price of these instances is based on the current market price.
AccountType String nis

The server type of the account. Valid values:

  • nis
  • ldap
Count Integer 3

The number of compute nodes in the cluster.

EhpcVersion String 1.0.0

The version of E-HPC.

Description String clusterdescription

The description of the cluster.

BaseOsTag String CentOS_7.2_64

The image tag of the base operating system. The tag is used only by the management node.

Name String test

The name of the cluster.

ImageId String wi_1607_x64_dtc_zh_40G_alibase****

The ID of the image.

ComputeSpotPriceLimit Float 0.034

The maximum hourly price for the ECS instance under the compute node. The return value can be accurate to three decimal places.

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.
NodeSuffix String name

The suffix of the node.

ImageOwnerAlias String system

The type of the image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image
  • marketplace: Alibaba Cloud Marketplace image
OsTag String CentOS_7.2_64

The image tag of the operating system.

NodePrefix String test

The prefix of the node.

InstanceType String ecs.n1.tiny

The instance type of the compute nodes.

RegionId String cn-hangzhou

The ID of the region.

InstanceChargeType String PostPaid

The billing methods of the instances that are deployed on the cluster. Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription
VSwitchId String vsw-bp1lfcjbfb099rrjn****

The ID of the vSwitch.

ZoneId String cn-hangzhou-c

The ID of the zone.

LoginNodes String {"Id": "i-bp13x4is8pvdhws7e****"}

The list of logon nodes.

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.

Managers Object

The list of management nodes.

OperatingCount Integer 1

The number of nodes that are being used in the queue. This includes those that are being initialized, installed, or released.

ExceptionCount Integer 0

The number of abnormal nodes.

StoppedCount Integer 0

The number of stopped nodes.

Total Integer 2

The total number of management nodes.

NormalCount Integer 1

The number of normal nodes.

Computes Object

The list of compute nodes.

OperatingCount Integer 1

The number of nodes that are being used in the queue. This includes those that are being initialized, installed, or released.

ExceptionCount Integer 0

The number of abnormal nodes.

StoppedCount Integer 0

The number of stopped nodes.

Total Integer 2

The total number of nodes.

NormalCount Integer 1

The number of normal nodes.

TotalResources Object

The statistics of all resources in the cluster.

Gpu Integer 0

The number of GPU cards. Unit: cards.
Cpu Integer 1

The number of CPU cores. Unit: cores.
Memory Integer 1024

The memory capacity.

UsedResources Object

The number of consumed resources in the cluster.

Gpu Integer 0

The number of GPU cards. Unit: cards.
Cpu Integer 1

The number of CPU cores. Unit: cores.
Memory Integer 1024

The memory capacity.

HasPlugin Boolean false

Indicates whether plug-ins are used in the cluster. Valid values:

  • true: Plug-ins are used.
  • false: Plug-ins are not used.

Default value: false

Examples

Sample requests

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

Sample success responses

XML format 

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

<ListClustersResponse>
    <PageSize>1</PageSize>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Clusters>
        <VpcId>vpc-b3f3edefefeep0760yju****</VpcId>
        <Status>running</Status>
        <CreateTime>2020-10-30T07:39:20.000Z</CreateTime>
        <IsComputeEss>false</IsComputeEss>
        <ComputeSpotStrategy>NoSpot</ComputeSpotStrategy>
        <AccountType>nis</AccountType>
        <Count>3</Count>
        <EhpcVersion>1.0.0</EhpcVersion>
        <Description>clusterdescription</Description>
        <BaseOsTag>CentOS_7.2_64</BaseOsTag>
        <Name>test</Name>
        <ImageId>wi_1607_x64_dtc_zh_40G_alibase****</ImageId>
        <ComputeSpotPriceLimit>0.034</ComputeSpotPriceLimit>
        <SchedulerType>pbs</SchedulerType>
        <DeployMode>Standard</DeployMode>
        <NodeSuffix>name</NodeSuffix>
        <ImageOwnerAlias>system</ImageOwnerAlias>
        <OsTag>CentOS_7.2_64</OsTag>
        <NodePrefix>test</NodePrefix>
        <InstanceType>ecs.n1.tiny</InstanceType>
        <RegionId>cn-hangzhou</RegionId>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <VSwitchId>vsw-bp1lfcjbfb099rrjn****</VSwitchId>
        <ZoneId>cn-hangzhou-c</ZoneId>
        <LoginNodes>{"Id": "i-bp13x4is8pvdhws7e****"}</LoginNodes>
        <Id>ehpc-hz-jeJki6****</Id>
        <Location>PublicCloud</Location>
        <ClientVersion>1.0.64</ClientVersion>
        <Managers>
            <OperatingCount>1</OperatingCount>
            <ExceptionCount>0</ExceptionCount>
            <StoppedCount>0</StoppedCount>
            <Total>2</Total>
            <NormalCount>1</NormalCount>
        </Managers>
        <Computes>
            <OperatingCount>1</OperatingCount>
            <ExceptionCount>0</ExceptionCount>
            <StoppedCount>0</StoppedCount>
            <Total>2</Total>
            <NormalCount>1</NormalCount>
        </Computes>
        <TotalResources>
            <Gpu>0</Gpu>
            <Cpu>1</Cpu>
            <Memory>1024</Memory>
        </TotalResources>
        <UsedResources>
            <Gpu>0</Gpu>
            <Cpu>1</Cpu>
            <Memory>1024</Memory>
        </UsedResources>
        <HasPlugin>false</HasPlugin>
    </Clusters>
</ListClustersResponse>

JSON format 

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

{
  "PageSize" : 1,
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Clusters" : [ {
    "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",
    "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

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.
404 ImageNotFound The specified image does not exist. The error message returned because the specified image does not exist.
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.
406 EcsError An error occurred while calling the ECS API operation. The error message returned because the ECS API call has failed.
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.
407 EntityNotExist.Role The role does not exist. The error message returned because the RAM role does not exist.
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.