All Products
Search

This Product

    Container Service for Kubernetes:DescribeClusterAttachScripts

    Document Center

    Container Service for Kubernetes:DescribeClusterAttachScripts

    Last Updated:Apr 04, 2026

    To manually add existing ECS instances to an ACK cluster as worker nodes or add nodes back to a node pool, call the DescribeClusterAttachScripts operation to obtain the required attachment script.

    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 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 node pool ID. You can add the node to a specific node pool.

    Note

    If you do not specify a node pool ID, the node is added to the default node pool.

    np1c9229d9be2d432c93f77a88fca0****
    format_disk

    boolean

    No

    Specifies whether to mount a data disk to the instance and store containers and images on the data disk when you manually add an existing instance to the cluster. Valid values:

    • true: Mounts the data disk to the instance. The original data on the data disk will be erased. Back up your data before you proceed.

    • false: Does not mount the data disk to the instance.

    Default value: false.

    Data disk mounting rules:

    • If an ECS instance has data disks attached and the last data disk is uninitialized, the system automatically formats that disk to ext4 and uses it to store content for /var/lib/docker and /var/lib/kubelet.

    • If no data disk is attached to the ECS instance, the system does not mount a new data disk.

    false
    keep_instance_name

    boolean

    No

    Specifies whether to retain the instance name when the instance is added to the cluster. If you do not retain the instance name, the system renames the instance to use the worker-k8s-for-cs-<clusterid> format. Valid values:

    • true: Retains the instance name.

    • false: Does not retain the instance name. The system renames the instance based on a system rule.

    Default value: true.

    true
    rds_instances

    array

    No

    If you specify a list of RDS instances, the system automatically adds the ECS instances of the cluster nodes to the access whitelists of the specified RDS instances.

    string

    No

    The ID of the RDS instance.

    rm-xxx
    arch

    string

    No

    The CPU architecture of the node. Supported CPU 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 configuration parameters for node attachment.

    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 Unix timestamp that indicates when the generated token expires. For example, the timestamp 1739980800 corresponds to 00:00:00 on February 20, 2025 (UTC).

    1740037333
    one_time_token

    boolean

    No

    Response elements

    Element

    Type

    Description

    Example

    string

    The node attachment 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.