Queries the nodes in a queue of a cluster.

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 ListNodesByQueue

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

ClusterId String Yes ehpc-hz-FYUr32****

The ID of the cluster.

QueueName String Yes workq

The name of the queue.

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 B405FF19-2D5F-4489-A84C-BC15CC1B24BD

The ID of the request.

PageNumber Integer 1

The number of the returned page.

TotalCount Integer 1

The total number of returned entries.

Nodes Array of NodeInfo

The list of nodes.

NodeInfo
VpcId String vpc-bp1gnu8br4ay7beb2w****

The ID of the virtual private cloud (VPC).

Status String untracking

The status of the node. Valid values:

  • uninit: The node is not initialized.
  • init: The node is being initialized.
  • ready: The node is ready.
  • running: The node is running.
  • exception: An exception has occurred on the node.
  • untracking: The node is not added to the cluster.
HtEnabled Boolean true

Indicates whether Hyper-Threading (HT) is enabled.

Expired Boolean false

Indicates whether the subscription node has expired. If the node is a pay-as-you-go node, false is returned.

ImageOwnerAlias String system

The type of the image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image
  • marketplace: Alibaba Cloud Marketplace image
LockReason String financial

The reason why the node is locked. Valid values:

  • financial: The node is locked due to overdue payments.
  • security: The node is locked due to security reasons.
  • recycling: The preemptible node is locked and pending release.
  • dedicatedhostfinancial: The node is locked due to the overdue payments of the dedicated host.

By default, an empty string is returned.

HostName String compute0

The name of the node.

PublicIpAddress String 10.34.**.**

The public IP address of the node.

SpotStrategy String NoSpot

The preemption policy for the Elastic Compute Service (ECS) instance. Valid values:

  • NoSpot: applies to regular 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.
CreatedByEhpc Boolean true

Indicates whether the node was created by using E-HPC.

RegionId String cn-hangzhou

The ID of the region.

VSwitchId String vsw-bp1e47optm9g58zcu****

The ID of the vSwitch.

IpAddress String 172.168.**.**

The private IP address of the node.

ExpiredTime String 2020-09-18T13:24:29.000Z

The time when the subscription instance expires. If the node is a pay-as-you-go node, a null value is returned.

Version String 1.0.64

The version of the E-HPC client.

ZoneId String cn-hangzhou-b

The ID of the zone.

AddTime String 2019-09-18T13:24:29.000Z

The time when the node was added to the cluster.

ImageId String centos_7_02_64_20G_alibase_20170818****

The ID of the image.

Location String PublicCloud

The location where the node is deployed. Valid values:

  • OnPremise: The node is deployed on a hybrid cloud.
  • PublicCloud: The node is deployed on a public cloud.
Id String i-bp13p7vlcb1uihfv****

The ID of the ECS instance.

CreateMode String manual

The mode in which the node was added. Valid values:

  • manual: The node was manually added.
  • autoscale: The node is automatically added.
TotalResources Object

The number of all resources in the cluster.

Gpu Integer 0

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

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

The memory capacity. Unit: GB.
UsedResources Object

The usage of the compute nodes in the cluster. For other types of nodes, an empty value is returned.

Gpu Integer 0

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

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

The memory capacity. Unit: GB.
StateInSched String active

The status of the node displayed on the scheduler. The status varies with the scheduler.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListNodesByQueue
&ClusterId=ehpc-hz-FYUr32****
&QueueName=workq
&<Common request parameters>

Sample success responses

XML format 

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

<ListNodesByQueueResponse>
    <PageSize>1</PageSize>
    <RequestId>B405FF19-2D5F-4489-A84C-BC15CC1B24BD</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Nodes>
        <VpcId>vpc-bp1gnu8br4ay7beb2w****</VpcId>
        <Status>untracking</Status>
        <HtEnabled>true</HtEnabled>
        <Expired>false</Expired>
        <ImageOwnerAlias>system</ImageOwnerAlias>
        <LockReason>financial</LockReason>
        <HostName>compute0</HostName>
        <PublicIpAddress>10.34.**.**</PublicIpAddress>
        <SpotStrategy>NoSpot</SpotStrategy>
        <CreatedByEhpc>true</CreatedByEhpc>
        <RegionId>cn-hangzhou</RegionId>
        <VSwitchId>vsw-bp1e47optm9g58zcu****</VSwitchId>
        <IpAddress>172.168.**.**</IpAddress>
        <ExpiredTime>2020-09-18T13:24:29.000Z</ExpiredTime>
        <Version>1.0.64</Version>
        <ZoneId>cn-hangzhou-b</ZoneId>
        <AddTime>2019-09-18T13:24:29.000Z</AddTime>
        <ImageId>centos_7_02_64_20G_alibase_20170818****</ImageId>
        <Location>PublicCloud</Location>
        <Id>i-bp13p7vlcb1uihfv****</Id>
        <CreateMode>manual</CreateMode>
        <TotalResources>
            <Gpu>0</Gpu>
            <Cpu>1</Cpu>
            <Memory>1024</Memory>
        </TotalResources>
        <UsedResources>
            <Gpu>0</Gpu>
            <Cpu>1</Cpu>
            <Memory>1</Memory>
        </UsedResources>
        <StateInSched>active</StateInSched>
    </Nodes>
</ListNodesByQueueResponse>

JSON format 

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

{
  "PageSize" : 1,
  "RequestId" : "B405FF19-2D5F-4489-A84C-BC15CC1B24BD",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Nodes" : [ {
    "VpcId" : "vpc-bp1gnu8br4ay7beb2w****",
    "Status" : "untracking",
    "HtEnabled" : true,
    "Expired" : false,
    "ImageOwnerAlias" : "system",
    "LockReason" : "financial",
    "HostName" : "compute0",
    "PublicIpAddress" : "10.34.**.**",
    "SpotStrategy" : "NoSpot",
    "CreatedByEhpc" : true,
    "RegionId" : "cn-hangzhou",
    "VSwitchId" : "vsw-bp1e47optm9g58zcu****",
    "IpAddress" : "172.168.**.**",
    "ExpiredTime" : "2020-09-18T13:24:29.000Z",
    "Version" : "1.0.64",
    "ZoneId" : "cn-hangzhou-b",
    "AddTime" : "2019-09-18T13:24:29.000Z",
    "ImageId" : "centos_7_02_64_20G_alibase_20170818****",
    "Location" : "PublicCloud",
    "Id" : "i-bp13p7vlcb1uihfv****",
    "CreateMode" : "manual",
    "TotalResources" : {
      "Gpu" : 0,
      "Cpu" : 1,
      "Memory" : 1024
    },
    "UsedResources" : {
      "Gpu" : 0,
      "Cpu" : 1,
      "Memory" : 1
    },
    "StateInSched" : "active"
  } ]
}

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.
400 NotEnabled You have not enabled this service The error message returned because the service is not activated for your account.
404 ClusterNotFound The specified cluster does not exist. The error message returned because the specified cluster does not exist.
404 ManagerNotFound The manager nodes do not exist or their status is abnormal. The error message returned because the management node does not exist or is not running as expected.
406 EcsError An error occurred while calling the ECS API operation. The error message returned because the ECS API call has failed.
406 DbError A database service error occurred. The error message returned because the database request has failed.
406 RedisError A Redis service error occurred. The error message returned because the Redis request has failed.
406 AgentError The agent service request failed. The error message returned because the proxy 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.