ListNodeGroupRefreshTasks - - Alibaba Cloud Documentation Center

Queries the list of node group configuration refresh tasks by paging.

Operation description

If you do not know which node group has refresh tasks, you can use conditional query. The task list contains only summary information. To query task details, use the DescribeNodeGroupRefreshTask operation.

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:ListNodeGroupRefreshTasks

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID.	i118191731740041623425
NodeGroupId	string	No	The node group ID.	ng-3525
Statuses	array	No	The list of task statuses. Valid values: Pending: The refresh task is created and waiting to be executed. InProgress: The refresh task is being processed. Success: The refresh task is executed. Failed: The refresh task failed.
	string	No	The task status.	Success
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous call. You do not need to set this parameter for the first request.	563d42ae0b17572449ec8c97f7f66069
MaxResults	integer	No	The maximum number of entries per page for paging. Valid values: 1 to 500. Default value: 100.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	Id of the request	03668372-18FF-5959-98D9-6B36A4643C7A
NextToken	string	The pagination token for the next query. If NextToken is empty, no more results exist.	563d42ae0b17572449ec8c97f7f66069
MaxResults	integer	The maximum number of entries per page.	20
NodeGroupRefreshTasks	array<object>	The list of node group refresh tasks.
	object
NodeGroupRefreshTaskId	string	The task ID.	task-159136551662516768776
NodeGroupId	string	The node group ID.	ng-3525
Status	string	The task status. Valid values: Pending: The refresh task is created and waiting to be executed. InProgress: The refresh task is being processed. Success: The refresh task is executed. Failed: The refresh task failed.	InProgress
TotalNodeCount	integer	The total number of nodes to be refreshed by the task.	100
FinishedCount	integer	The number of finished nodes, including succeeded, failed, and skipped nodes.	45
FailedCount	integer	The number of failed nodes.	2
StartTime	string	The start time of the refresh task in ISO 8601 format.	2026-04-20T10:00:00Z
EndTime	string	The end time of the refresh task in ISO 8601 format.	2026-04-20T10:30:00Z
MaxDisruptiveAction	string	The maximum disruptive action level allowed for the refresh operation.	Refresh

Examples

Success response

JSON format

{
  "RequestId": "03668372-18FF-5959-98D9-6B36A4643C7A",
  "NextToken": "563d42ae0b17572449ec8c97f7f66069",
  "MaxResults": 20,
  "NodeGroupRefreshTasks": [
    {
      "NodeGroupRefreshTaskId": "task-159136551662516768776",
      "NodeGroupId": "ng-3525",
      "Status": "InProgress",
      "TotalNodeCount": 100,
      "FinishedCount": 45,
      "FailedCount": 2,
      "StartTime": "2026-04-20T10:00:00Z",
      "EndTime": "2026-04-20T10:30:00Z",
      "MaxDisruptiveAction": "Refresh"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.