RefreshNodeGroupNodes - - Alibaba Cloud Documentation Center

Refreshes node group configurations to existing nodes. Manually triggers the node group configuration to take effect on existing nodes. After node group properties are changed, existing nodes do not perform automatic synchronization by default, which causes configuration drift. You can call this operation to refresh node properties. The operation returns an asynchronous refresh task ID, and the result can be queried through DescribeNodeGroupRefreshTask.

Operation description

Manually triggers the node group configuration to take effect on existing nodes. After node group properties are changed, existing nodes do not perform automatic synchronization by default, which causes configuration drift. You can call this operation to refresh node properties. The operation returns an asynchronous refresh task ID, and the result can be queried through DescribeNodeGroupRefreshTask.

Limits:

A node group can have only one running node group configuration refresh task at a time.
When the asynchronous task executes the refresh, if a node is not in the "In Use" state, the refresh of that node is failed.
Warning Currently, only the RamRoleName property is supported for refresh.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NodeGroupId	string	Yes	The node group ID.	ng-3525
MaxDisruptiveAction	string	No	The maximum disruptive action level allowed for the refresh operation. The system independently evaluates the action level required to refresh each drifted property of a node and performs the refresh within the specified action level constraint. If the action level required for a property exceeds the specified level, that property is skipped. Action levels in increasing order of disruption: Refresh < Reboot < Reimage. Refresh (default): only refreshes the configuration in place without restarting or reimaging. Currently applicable only to the RamRoleName property. Reboot (not currently supported): allows restarting the node for the configuration to take effect. Supported properties include system cloud disk type and all properties supported by Refresh. Reimage (not currently supported): allows reimaging the node for the configuration to take effect. Supported properties include image ID and all properties supported by Reboot.	Refresh
NodeIds	array	No	The filter scope for node refresh. If not specified, all nodes in the node group are included. Warning If the instance type is a hypernode, pass in the TrayNode ID, not the HyperNodeId.
	string	No	The list of nodes. A maximum of 500 nodes can be specified in a single batch.	['mock-sn-200101']

Response elements

Element	Type	Description	Example
	object
RequestId	string	Id of the request	4FD06DF0-9167-5C6F-A145-F30CA4A15D54
NodeGroupRefreshTaskId	string	The task ID. Query the task progress through DescribeNodeGroupRefreshTask. If no node has configuration drift, no task is created and this field returns an empty string.	task-159136551662516768776

Examples

Success response

JSON format

{
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "NodeGroupRefreshTaskId": "task-159136551662516768776"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.