DescribeNodeGroupRefreshTask - - Alibaba Cloud Documentation Center

Queries the detailed progress of a node group configuration refresh task. Returns the actual execution result for each node, including refreshed properties, properties skipped because they exceeded the MaxDisruptiveAction constraint, and failure reasons.

Operation description

The returned results include the following:

The processing status of each node with configuration drift
The processing result, status, and reason for each node
The refreshed and skipped properties for each node

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NodeGroupRefreshTaskId	string	Yes	The ID of the refresh task.	task-159136551662516768776
NodeStatuses	array	No	The node refresh statuses to filter by. Valid values: Pending: the node is waiting to be refreshed. InProgress: the node is being refreshed. Success: the node is refreshed. Failed: the node failed to be refreshed. Skipped: all properties to be refreshed on the node exceeded the MaxDisruptiveAction constraint and were skipped.
	string	No	The list of node statuses. If this parameter is not specified, nodes in all statuses are returned.	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. This parameter is used to paginate through the node list in the current refresh task.	563d42ae0b17572449ec8c97f7f66069
MaxResults	integer	No	The maximum number of entries per page for a paged query. Valid values: 1 to 500. Default value: 100. For more information about paging, set the NextToken parameter.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	Id of the request	4FD06DF0-9167-5C6F-A145-F30CA4A15D54
NextToken	string	The token for the next query. An empty value of NextToken indicates that no more results exist.	7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b
MaxResults	integer	The maximum number of entries per page.	20
NodeGroupRefreshTaskId	string	The ID of the refresh task.	task-159136551662516768776
NodeGroupId	string	The ID of the node group.	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 to be executed.	InProgress
TotalNodeCount	integer	The total number of nodes to be refreshed in the task.	100
FinishedCount	integer	The number of finished nodes, including successful, 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
Nodes	array<object>	The list of nodes.
	array<object>	The node details.
NodeId	string	The ID of the node.	node-001
Action	string	The action level actually executed on the node. If multiple properties are refreshed on the node, the highest required action level is used. Valid values: Refresh: in-place refresh. Reboot: restart. Reimage: reimage. If the entire node is skipped, this value is empty.	Refresh
Status	string	The node refresh status. Valid values: Pending: the node is waiting to be refreshed. InProgress: the node is being refreshed. Success: the node is refreshed. Failed: the node failed to be refreshed. Skipped: all properties to be refreshed on the node exceeded the MaxDisruptiveAction constraint and were skipped.	Success
ErrorCode	string	The error code.	NodeInMaintenance
ErrorMessage	string	The error message.	The node has been confirmed for maintenance and there is no need to confirm the maintenance again. sn: 21B917666,status:ClusterNodeRepairing
PropertyDrifts	array<object>	The list of property drifts for the node, including both executed and skipped properties.
	object
PropertyPath	string	The property path in dot notation.	RamRoleName
ActualValue	string	The current value of the node property. Complex types are serialized as JSON strings.	old-role
TargetValue	string	The target value of the node property. Complex types are serialized as JSON strings.	new-role
MinRequiredAction	string	The minimum action required to apply the target value: Refresh / Reboot / Reimage. For more information, see the MaxDisruptiveAction parameter description in the RefreshNodeGroupNodes operation.	Refresh
Skipped	boolean	Indicates whether the property was skipped because it exceeded the MaxDisruptiveAction constraint.	false

Examples

Success response

JSON format

{
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "NextToken": "7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b",
  "MaxResults": 20,
  "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",
  "Nodes": [
    {
      "NodeId": "node-001",
      "Action": "Refresh",
      "Status": "Success",
      "ErrorCode": "NodeInMaintenance",
      "ErrorMessage": "The node has been confirmed for maintenance and there is no need to confirm the maintenance again. sn: 21B917666,status:ClusterNodeRepairing",
      "PropertyDrifts": [
        {
          "PropertyPath": "RamRoleName",
          "ActualValue": "old-role",
          "TargetValue": "new-role",
          "MinRequiredAction": "Refresh",
          "Skipped": false
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.