All Products
Search

This Product

    Container Service for Kubernetes:DescribeClusterAttachScripts

    Document Center

    Container Service for Kubernetes:DescribeClusterAttachScripts

    Last Updated:Nov 07, 2024

    Queries the scripts used to add existing nodes to a Container Service for Kubernetes (ACK) cluster. ACK allows you to manually add existing Elastic Compute Service (ECS) instances to an ACK cluster as worker nodes or re-add worker nodes that you remove from the cluster to a node pool.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cs:DescribeClusterAttachScriptsupdate
    • Cluster
      acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
      none
    		none

    Request syntax

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClusterIdstringYes

    The cluster ID.

    		ca375a93a30474552ad2a0ebe183e****
    bodyobjectNo

    The request body.

    nodepool_idstringNo

    The ID of the node pool to which you want to add an existing node. This parameter allows you to add an existing node to a specified node pool.

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

    Specifies whether to mount data disks to an existing instance when you add the instance to the cluster. You can add data disks to store container data and images. Valid values:

    • true: mounts data disks to the existing instance that you want to add. After a data disk is mounted, the original data on the disk is erased. Back up data before you mount a data disk.
    • false: does not mount data disks to the existing instance.

    Default value: false.

    How a data disk is mounted:

    • If the Elastic Compute Service (ECS) instances are already mounted with data disks and the file system of the last data disk is not initialized, the system automatically formats this data disk to ext4 and mounts it to /var/lib/docker and /var/lib/kubelet.
    • If no data disk is mounted to the ECS instance, the system does not purchase a new data disk.
    		false
    keep_instance_namebooleanNo

    Specifies whether to retain the name of the existing instance when it is added to the cluster. If you do not retain the instance name, the instance is named in the worker-k8s-for-cs-<clusterid> format. Valid values:

    • true: retains the instance name.
    • false: does not retain the instance name.

    Default value: true

    		true
    rds_instancesarrayNo

    After you specify the list of RDS instances, the ECS instances in the cluster are automatically added to the whitelist of the RDS instances.

    stringNo

    The names of the ApsaraDB RDS instances.

    		rm-xxx
    archstringNo

    The CPU architecture of the node. Valid values: amd64, arm, and arm64.

    Default value: amd64.

    Note This parameter is required if you want to add the existing node to a Container Service for Kubernetes (ACK) Edge cluster.
    		amd64
    optionsstringNo

    The node configurations for the existing instance that you want to add as a node.

    Note This parameter is required if you want to add the existing node to an ACK Edge cluster.
    		{\"enableIptables\": true,\"manageRuntime\": true,\"quiet\": true,\"allowedClusterAddons\": [\"kube-proxy\",\"flannel\",\"coredns\"]}

    Response parameters

    ParameterTypeDescriptionExample
    string

    The returned script that is used to add an existing instance to the ACK cluster.

    		"curl http://aliacs-k8s-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/public/pkg/run/attach/1.12.6-aliyunedge.1/edgeadm -O edgeadm; chmod u+x edgeadm; ./edgeadm join --openapi-token=XXX --node-spec="{\"flannelIface\":\"eth0\",\"enableIptables\":true,\"assumeYes\":true,\"manageRuntime\":true,\"nodeNameStrategy\":\"hostname\",\"enabledAddons\":[\"kube-proxy\",\"flannel\",\"coredns\"]}""

    Examples

    Sample success responses

    JSONformat

    "\"curl http://aliacs-k8s-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/public/pkg/run/attach/1.12.6-aliyunedge.1/edgeadm -O edgeadm; chmod u+x edgeadm; ./edgeadm join --openapi-token=XXX --node-spec=\"{\\\"flannelIface\\\":\\\"eth0\\\",\\\"enableIptables\\\":true,\\\"assumeYes\\\":true,\\\"manageRuntime\\\":true,\\\"nodeNameStrategy\\\":\\\"hostname\\\",\\\"enabledAddons\\\":[\\\"kube-proxy\\\",\\\"flannel\\\",\\\"coredns\\\"]}\"\""

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history