Use DescribeClusterAttachScripts to query scripts for adding existing nodes - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Call the DescribeClusterAttachScripts operation to get the script required to add an existing ECS instance to an ACK cluster as a worker node, or to re-add a removed node to a node pool.

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

cs:DescribeClusterAttachScripts

update

*Cluster

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

None

Request syntax

POST /clusters/{ClusterId}/attachscript HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	ca375a93a30474552ad2a0ebe183e****

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.	amd64
nodepool_id	string	No	The ID of the node pool to which the node will be added. Note If you omit this parameter, the system adds the node to the default node pool.	np1c9229d9be2d432c93f77a88fca0****
format_disk	boolean	No	Specifies whether to format and mount a data disk for storing containers and images when you add an existing instance to the cluster. Valid values: `true`: Mounts a data disk to the instance. The original data on the disk will be erased. Back up any important data on the disk before proceeding. `false`: Does not mount a data disk to the instance. Default value: `false`. Data mounting rules: If the last attached data disk of an ECS instance has an uninitialized file system, the system automatically formats that disk to ext4 and uses it for the `/var/lib/docker` and `/var/lib/kubelet` directories. If the ECS instance does not have a data disk, the system will not mount one.	false
keep_instance_name	boolean	No	Specifies whether to retain the original instance name. If set to `false`, the system renames the instance in the format of `worker-k8s-for-cs-<clusterid>`. `true`: Retains the original instance name. `false`: Renames the instance based on a predefined naming convention. Default value: `true`.	true
rds_instances	array	No	A list of RDS instance IDs. If specified, the system automatically adds the IP addresses of the cluster's ECS nodes to the access allowlist of these RDS instances.
	string	No	An RDS instance ID.	rm-xxx
arch	string	No	The CPU architecture of the node. Supported architectures include `amd64`, `arm`, and `arm64`. Default value: `amd64`. Note This parameter is required if the cluster is a managed edge cluster.	amd64
options	string	No	The node attach options. Note This parameter is required if the cluster is a managed edge cluster.	{"enableIptables": true,"manageRuntime": true,"quiet": true,"allowedClusterAddons": ["kube-proxy","flannel","coredns"]}
expired	integer	No	The expiration time of the generated token, specified as a Unix timestamp. For example, the timestamp `1739980800` corresponds to `2025-02-20 00:00:00`.	1740037333
one_time_token	boolean	No

Response elements

Element	Type	Description	Example
	string	The node attach script.	"wget http://*.oss-cn-hangzhou.aliyuncs.com/*"

Examples

Success response

JSON format

"\"wget http://***.oss-cn-hangzhou.aliyuncs.com/***\""

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.