Retrieve PAI Cluster Node Groups via ListNodeGroups API - Platform For AI

Query Node Group Information Under the Cluster

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:ListNodeGroups

list

*Cluster

acs:eflo:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
NodeGroupId	string	No	The node group ID.	ng-ec3c96ff0aa4c60d
NextToken	string	No	The token that is used in the next request to retrieve a new page of results.	a3f2224a5ec7224116c4f5246120abe4
ClusterId	string	No	The cluster ID.	i119982311660892626523
MaxResults	integer	No	The number of entries per page. Maximum value: 100. Default value: • If you do not configure this parameter or if you set this parameter to a value less than 20, the default value is 20. • If you set this parameter to a value greater than 100, the default value is 100.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	887FA855-89F4-5DB3-B305-C5879EC480E6
NextToken	string	The token that is used in the next request to retrieve a new page of results.	563d42ae0b17572449ec8c97f7f66069
Groups	array<object>	The node groups.
	object
ClusterId	string	The cluster ID.	i113952461729854708648
ClusterName	string	The cluster name.	wzq-exclusivelite-71
CreateTime	string	The creation time.	2024-02-27T13:16:31.599
Description	string	The description.	created by ga2_prepare
GroupId	string	The group ID.	238276221
GroupName	string	The group name.	backend-group
ImageId	string	The image ID.	i194015071707321240258
ImageName	string	The image name.	CentOS_7.9_x86_64_FULL_20221110
MachineType	string	The instance type.	efg1.nvga1n
NodeCount	integer	The number of nodes.	2
UpdateTime	string	The update time.	2023-09-22T00:03:05.114
ZoneId	string	The zone ID.	cn-shenzhen-c
FileSystemMountEnabled	boolean	Indicates whether file storage mounting is supported.
VirtualGpuEnabled	boolean	Whether to enable gpu virtualization or not	false

Examples

Success response

JSON format

{
  "RequestId": "887FA855-89F4-5DB3-B305-C5879EC480E6",
  "NextToken": "563d42ae0b17572449ec8c97f7f66069",
  "Groups": [
    {
      "ClusterId": "i113952461729854708648",
      "ClusterName": "wzq-exclusivelite-71",
      "CreateTime": "2024-02-27T13:16:31.599",
      "Description": "created by ga2_prepare",
      "GroupId": "238276221",
      "GroupName": "backend-group",
      "ImageId": "i194015071707321240258",
      "ImageName": "CentOS_7.9_x86_64_FULL_20221110",
      "MachineType": "efg1.nvga1n",
      "NodeCount": 2,
      "UpdateTime": "2023-09-22T00:03:05.114",
      "ZoneId": "cn-shenzhen-c",
      "FileSystemMountEnabled": false,
      "VirtualGpuEnabled": false
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.