ListNodesByQueue - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the node information of a single cluster within an Alibaba Cloud account by queue.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:ListNodesByQueue		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the E-HPC cluster.	ehpc-hz-FYUr32****
QueueName	string	Yes	The name of the queue.	workq
PageNumber	integer	No	The number of the page to return. Pages start from page 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10
Async	boolean	No	Specifies whether to enable asynchronous query.	false

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
RequestId	string	The request ID.	B405FF19-2D5F-4489-A84C-BC15CC1B24BD
PageNumber	integer	The number of the returned page.	1
TotalCount	integer	The total number of returned entries.	1
Nodes	array<object>	The list of nodes.
NodeInfo	object
VpcId	string	The VPC ID of the node.	vpc-bp1gnu8br4ay7beb2w****
Status	string	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 cluster is running. exception: An exception occurred on the node. untracking: The node is not added to the cluster.	untracking
HtEnabled	boolean	Indicates whether Hyper-Threading (HT) is enabled.	true
Expired	boolean	Indicates whether the subscription node has expired. If the node is a pay-as-you-go node, false is returned.	false
ImageOwnerAlias	string	The type of the image. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image	system
LockReason	string	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
HostName	string	The node name.	compute0
PublicIpAddress	string	The public IP address of the node.	10.34..
SpotStrategy	string	The preemption policy of the instance. Valid values: NoSpot: The instance is created as a pay-as-you-go instance. SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price. SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.	NoSpot
CreatedByEhpc	boolean	Indicates whether the node was created by using E-HPC.	true
RegionId	string	The region ID.	cn-hangzhou
VSwitchId	string	The vSwitch ID.	vsw-bp1e47optm9g58zcu****
IpAddress	string	The private IP address of the node.	172.168..
ExpiredTime	string	The time when the subscription instance expires. If the node is a pay-as-you-go node, a null value is returned.	2020-09-18T13:24:29.000Z
Version	string	The version of the E-HPC client.	1.0.64
ZoneId	string	The zone ID of the node.	cn-hangzhou-b
AddTime	string	The time when the node was added to the cluster.	2019-09-18T13:24:29.000Z
ImageId	string	The image ID.	centos_7_02_64_20G_alibase_20170818****
Location	string	The location where the node is deployed. Valid values: OnPremise: The cluster is deployed on a hybrid cloud. PublicCloud: The cluster is deployed on a public cloud.	PublicCloud
Id	string	The ID of the instance.	i-bp13p7vlcb1uihfv****
CreateMode	string	The mode in which the node is created. Valid values: manual: The node is manually added. autoscale: The node is automatically added.	manual
TotalResources	object	The number of all resources in the cluster.
Gpu	integer	The total number of GPU cards. Unit: cards.	0
Cpu	integer	The number of CPU cores. Unit: cores.	1
Memory	integer	The memory capacity. Unit: GB.	1024
UsedResources	object	The usage of the compute nodes in the cluster. For other types of nodes, an empty value is returned.
Gpu	integer	The total number of GPU cards. Unit: cards.	0
Cpu	integer	The number of CPU cores. Unit: cores.	1
Memory	integer	The memory capacity. Unit: GB.	1
StateInSched	string	The status of the node displayed on the scheduler. The status varies with the scheduler.	active

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "RequestId": "B405FF19-2D5F-4489-A84C-BC15CC1B24BD",
  "PageNumber": 1,
  "TotalCount": 1,
  "Nodes": {
    "NodeInfo": [
      {
        "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

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
400	NotEnabled	You have not enabled this service	You have not enabled this service
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
404	ManagerNotFound	The manager nodes do not exist or their status is abnormal.	The manager nodes do not exist or their status is abnormal.
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
406	DbError	A database service error occurred.	Database request failed.
406	RedisError	A Redis service error occurred.	Redis request failed.
406	AgentError	The agent service request failed.	The cluster-side command failed to run. %s
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The 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 time	Summary of changes	Operation
2021-12-22	The Error code has changed. The response structure of the API has changed	View Change Details