All Products
Search
Document Center

Elastic High Performance Computing:ListNodes

Last Updated:Apr 09, 2024

Queries the list of nodes in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListNodesREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the cluster.

You can call the ListClusters operation to query the cluster ID.

ehpc-hz-FYUr32****
RolestringNo

The type of the node. Valid values:

  • Manager: management node
  • Login: logon node
  • Compute: compute node
Manager
HostNamestringNo

The name of the node. You can perform a fuzzy search. MySQL regular expressions are supported.

test-HostName
PageNumberintegerNo

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

1
PageSizeintegerNo

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

Default value: 10.

10
SequencestringNo

The sorting method of the node list. Valid values:

  • Forward: sorts the nodes in chronological order.
  • Backward: sorts the nodes in reverse chronological order.

Default value: Forward.

Note This parameter is used together with the SortBy parameter. If you set SortBy to AddedTime and set Sequence to Forward, nodes are queried in ascending order of time that they are added.
Forward
SortBystringNo

The sorting method of the node list. Valid values:

  • AddedTime: sorts the nodes by the time that they are added.
  • HostName: sorts the nodes by their host names.
AddedTime
FilterstringNo

The filter options of the node list.

Format: {"status":"node_status"}. Replace node_status with the node status. Valid values of node_status:

  • uninit: The node is being installed.
  • exception: An exception occurred on the node.
  • running: The node is running.
  • initing: The node is being initialized.
  • releasing: The node is being released.
  • untracking: The node is not added to the cluster.
  • stopped: The node is stopped.
{"status":"running"}
PrivateIpAddressstringNo

The private IP address of the node.

172.16.**.**
HostNamePrefixstringNo

The prefix of the hostname. You can query nodes that have a specified prefix.

compute
HostNameSuffixstringNo

The suffix of the hostname. You can query nodes that have a specified suffix.

01

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

1
RequestIdstring

The request ID.

89A1AC0F-4A6C-4F3D-98F9-BEF9A823****
PageNumberinteger

The page number returned.

1
TotalCountinteger

The total number of returned entries.

1
Nodesobject []

The list of nodes.

VpcIdstring

The VPC ID of the node.

vpc-bp1gnu8br4ay7beb2w****
Statusstring

The status of the node. Valid values:

  • uninit: The node is being installed.
  • exception: An exception occurred on the node.
  • running: The node is running.
  • initing: The node is being initialized.
  • releasing: The node is being released.
  • untracking: The node is not added to the cluster.
  • stopped: The node is stopped.
running
HtEnabledboolean

Indicates whether hyper-threading is enabled.

true
Expiredboolean

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

false
ImageOwnerAliasstring

The type of the image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image
  • marketplace: Alibaba Cloud Marketplace image
system
LockReasonstring

The reason why the node is locked. Valid values:

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

By default, an empty string is returned.

financial
HostNamestring

The name of the task node.

test-HostName
InstanceTypestring

The instance types of the node.

ecs.c5.large
PublicIpAddressstring

The public IP address of the server.

172.16.**.**
SpotStrategystring

The bidding method of the compute nodes.

NoSpot
CreatedByEhpcboolean

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

  • true: The node is created by using E-HPC.
  • false: The node is not created by using E-HPC.
true
RegionIdstring

The region ID.

cn-hangzhou
VSwitchIdstring

The vSwitch ID.

vsw-bp1e47optm9g58zcu****
IpAddressstring

The IP address of the node.

172.16.**.**
ExpiredTimestring

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

2020-06-09T06:22:02.000Z
Versionstring

The version of the client that is used for the cluster.

1.0.78
ZoneIdstring

The zone ID.

cn-hangzhou-b
AddTimestring

The time when the node is added to the cluster.

2020-06-09T06:22:02.000Z
ImageIdstring

The ID of the custom image.

centos_7_06_64_20G_alibase_20190711.vhd
Locationstring

The location where the node is deployed. Valid values:

  • OnPremise: The node is deployed on your data center.
  • PublicCloud: The node is deployed on the public cloud.
PublicCloud
Idstring

The node ID.

i-bp15707mys2rsy0j****
CreateModestring

The mode in which the compute nodes are added. Valid values:

  • manual: The node is manually added.
  • autoscale: The node is automatically added.
manual
Rolesarray

The type of the node. Valid values:

  • Scheduler: primary scheduling node
  • SchedulerBackup: secondary scheduling node
  • Account: primary domain server node
  • AccountBackup: secondary domain server node
  • Login: logon node
  • Compute: compute node

Scheduling nodes and domain server nodes are management nodes.

string

The type of the node. Valid values:

  • Scheduler: primary scheduling node
  • SchedulerBackup: secondary scheduling node
  • Account: primary domain server node
  • AccountBackup: secondary domain server node
  • Login: logon node
  • Compute: compute node

Scheduling nodes and domain server nodes are management nodes.

[“Compute”]
TotalResourcesobject

The statistics of the resources used by the node.

Gpuinteger

The number of GPUs.

0
Cpuinteger

The number of vCPUs.

1
Memoryinteger

The memory capacity. Unit: GB.

1024
UsedResourcesobject

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

Gpuinteger

The number of GPUs.

0
Cpuinteger

The number of vCPUs.

0
Memoryinteger

The memory capacity. Unit: GB.

0
StateInSchedstring

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

active

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "RequestId": "89A1AC0F-4A6C-4F3D-98F9-BEF9A823****",
  "PageNumber": 1,
  "TotalCount": 1,
  "Nodes": {
    "NodeInfo": [
      {
        "VpcId": "vpc-bp1gnu8br4ay7beb2w****",
        "Status": "running",
        "HtEnabled": true,
        "Expired": false,
        "ImageOwnerAlias": "system",
        "LockReason": "financial",
        "HostName": "test-HostName",
        "InstanceType": "ecs.c5.large",
        "PublicIpAddress": "172.16.**.**",
        "SpotStrategy": "NoSpot",
        "CreatedByEhpc": true,
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1e47optm9g58zcu****",
        "IpAddress": "172.16.**.**",
        "ExpiredTime": "2020-06-09T06:22:02.000Z",
        "Version": "1.0.78",
        "ZoneId": "cn-hangzhou-b",
        "AddTime": "2020-06-09T06:22:02.000Z",
        "ImageId": "centos_7_06_64_20G_alibase_20190711.vhd",
        "Location": "PublicCloud",
        "Id": "i-bp15707mys2rsy0j****",
        "CreateMode": "manual",
        "Roles": {
          "Role": [
            "[“Compute”]"
          ]
        },
        "TotalResources": {
          "Gpu": 0,
          "Cpu": 1,
          "Memory": 1024
        },
        "UsedResources": {
          "Gpu": 0,
          "Cpu": 0,
          "Memory": 0
        },
        "StateInSched": "active"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
400NotEnabledYou have not enabled this serviceYou have not enabled this service
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.The manager nodes do not exist or their status is abnormal.
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
406DbErrorA database service error occurred.Database request failed.
406RedisErrorA Redis service error occurred.Redis request failed.
406AgentErrorThe agent service request failed.-
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2021-12-22The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Output ParametersThe response structure of the API has changed.