ListNodes-阿里云帮助中心

Returns a list of resource nodes.

Operation description

ListNodes retrieves resource nodes that match specified filter conditions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/v1/nodes HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupIds	string	No	A comma-separated list of resource group IDs. You must specify either this parameter or `QuotaId`. Constraints: The user ID of the request must match the user ID associated with the specified resource groups. All specified resource groups must be of the same type. All specified resource groups must be in the same VPC.	rg69rj0leslwdnbe
QuotaId	string	No	The ID of the resource quota that contains the nodes.	quotamtl37ge7gkvdz
NodeTypes	string	No	A comma-separated list of node specifications. If this parameter is omitted, this operation returns nodes of all specifications.	ecs.c6.xlarge
AcceleratorType	string	No	The accelerator type. Valid values: CPU GPU If omitted, this operation returns nodes of all accelerator types.	CPU
GPUType	string	No	The GPU type. Fuzzy matching is supported.	T4
NodeStatuses	string	No	A comma-separated list of node statuses. If this parameter is omitted, this operation returns nodes of all statuses.	Ready
OrderStatuses	string	No	A comma-separated list of order statuses.	Ready
PageNumber	integer	No	The page number. The first page is 1.	2
PageSize	integer	No	The number of entries to return per page.	10
SortBy	string	No	The field by which to sort the results.	GmtCreateTime
Order	string	No	The sort order. Valid values: `desc`: Descending `asc`: Ascending	desc
Verbose	boolean	No	Specifies whether to return resource usage information. This parameter applies only when `QuotaId` is specified.	false
NodeNames	string	No	A comma-separated list of node names. Only nodes with names that match this list are returned.	lingjxxxx
HyperNode	string	No
CliqueID	string	No
FilterByQuotaId	string	No	When used with `ResourceGroupIds`, this parameter further filters the results to include only nodes from the specified resource quota.	quotamtl37ge7gkvdz
FilterByResourceGroupIds	string	No	When used with `QuotaId`, this parameter further filters the results to include only nodes from the specified resource groups.	rg69rj0leslwdnbe
MachineGroupIds	string	No
ReasonCodes	string	No
HyperZone	string	No
AvailabilityZone	string	No
PaymentType	string	No
OrderInstanceIds	string	No	A comma-separated list of order IDs.	260590501560397
WorkspaceId	string	No
HealthRate	object	No
operation	string	No
value	integer	No
HealthCount	object	No
operation	string	No
value	integer	No
LayoutMode	string	No
ResourceGroupName	string	No
DiskPL	string	No
WorkloadNum	integer	No
PodNum	integer	No

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Nodes	array	The list of nodes.
	Node	The node information.
TotalCount	integer	The number of nodes that meet the filter conditions.	23

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Nodes": [
    {
      "CreatorId": "281044699048527748",
      "NodeName": "lingjxxxx",
      "NodeType": "ecs.c8i.xlarge",
      "AcceleratorType": "CPU",
      "CPU": "4",
      "Memory": "8",
      "GPU": "0",
      "GPUType": "\"\"",
      "GPUMemory": "",
      "NodeStatus": "Ready",
      "ReasonCode": "\"\"",
      "ReasonMessage": "\"\"",
      "OrderStatus": "Ready",
      "ResourceGroupId": "rgf0zhfqn1d4ity2",
      "ResourceGroupName": "test",
      "MachineGroupId": "mg1234456",
      "GmtCreateTime": "2024-07-10T11:49:47Z",
      "GmtCreatedTime": "",
      "GmtModifiedTime": "2024-07-10T11:49:47Z",
      "GmtExpiredTime": "2025-06-22T00:00:00Z\n",
      "IsBound": false,
      "BoundQuotas": [
        {
          "QuotaId": "quota12345",
          "QuotaName": "dlc-quota"
        }
      ],
      "RequestCPU": "4",
      "RequestMemory": "8",
      "RequestGPU": "0",
      "LimitCPU": "4",
      "LimitMemory": "8",
      "LimitGPU": "0",
      "PodNum": 2,
      "WorkloadNum": 2,
      "Users": [
        {
          "UserId": "161222222222",
          "UserName": "test"
        }
      ],
      "HyperZone": "",
      "AvailabilityZone": "",
      "AllocatableCPU": "",
      "AllocatableMemory": "",
      "SystemReservedCPU": "",
      "SystemReservedMemory": "",
      "AncestorQuotaWorkloadNum": 0,
      "SelfQuotaWorkloadNum": 0,
      "DescendantQuotaWorkloadNum": 0,
      "DiskPL": "",
      "DiskCapacity": 0,
      "SubNodes": [
        ""
      ]
    }
  ],
  "TotalCount": 23
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.