Queries the information about nodes in a specified queue in 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 ListVolumes.

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 returned per page. Valid values: 1 to 50

Default value: 10

Response parameters

Parameter Type Example Description
Nodes Array of NodeInfo

The information about nodes.

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

The time when the node was added to the cluster.

CreateMode String manual

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

  • manual: The cluster is manually scaled.
  • autoscale: The cluster is auto-scaled.
CreatedByEhpc Boolean true

Specifies whether the node is created by using Elastic High Performance Computing (E-HPC).

Expired Boolean false

Indicates whether the subscription node expires. If the node is pay-as-you-go, the value of this parameter is false.

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

The time when the subscription instance expires. If the node is pay-as-you-go, no value is returned for this parameter.

HostName String compute0

The name of the node.

HtEnabled Boolean true

Indicates whether Hyper-Threading (HT) is enabled.

Id String i-bp13p7vlcb1uihfv****

The ID of the node instance.

ImageId String centos_7_02_64_20G_alibase_20170818****

The ID of the image.

ImageOwnerAlias String system

The type of image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image
  • marketplace: Alibaba Cloud Marketplace image
IpAddress String 172.168.**. **

The private IP address of the node.

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.
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 for security reasons.
  • recycling: The preemptible node instance is locked and pending release.
  • dedicatedhostfinancial: The Elastic Compute Service (ECS) instance is locked due to overdue payments for the dedicated host.

This parameter is empty by default.

PublicIpAddress String 10.34.**. **

The public IP address of the node.

RegionId String cn-hangzhou

The ID of the region.

SpotStrategy String NoSpot

The preemption policy for the instance. Valid values:

  • NoSpot: The instance is created as a regular pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is a preemptible instance with a user-defined maximum hourly rate.
  • SpotAsPriceGo: The node is created as a pay-as-you-go instance that is automatically priced by using the amount on Alibaba Cloud Marketplace.
Status String untracking

The status of cluster nodes. Valid values:

  • uninit: The nodes are not initialized.
  • init: The nodes are being initialized.
  • ready: The nodes are ready.
  • running: The nodes are running.
  • exception: One or mode nodes are encountering an exception.
  • untracking: The nodes are not added to the cluster.
TotalResources Struct

The statistics of all resources in the cluster.

Cpu Integer 1

The number of CPU cores. Unit: cores.

Gpu Integer 0

The total number of GPU cards. Unit: cards.

Memory Integer 1024

The memory capacity. Unit: GB.

UsedResources Struct

The statistics of compute nodes in the cluster. For other types of nodes, no value is returned.

Cpu Integer 1

The number of CPU cores. Unit: cores.

Gpu Integer 0

The total number of GPU cards. Unit: cards.

Memory Integer 1

The memory capacity. Unit: GB.

VSwitchId String vsw-bp1e47optm9g58zcu****

The ID of the vSwitch.

Version String 1.0.64

The version number of the client that is used in the cluster.

VpcId String vpc-bp1gnu8br4ay7beb2w****

The ID of the virtual private cloud (VPC).

ZoneId String cn-hangzhou-b

The ID of the zone to which the instance belongs.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 1

The number of entries returned per page.

RequestId String B405FF19-2D5F-4489-A84C-BC15CC1B24BD

The ID of the request.

TotalCount Integer 1

The total number of entries.

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

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

JSON format

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

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.