DescribeClusterAttachScripts - 查询添加已有节点到集群节点池的脚本

如果需要将已有ECS实例添加到ACK集群中作为Worker节点,或移除Worker节点后需将节点实例重新加入节点池,ACK支持手动将已有节点到节点池。您可以调用DescribeClusterAttachScripts接口获取添加已有节点的脚本。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeClusterAttachScriptsupdate
*Cluster
acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

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

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

ca375a93a30474552ad2a0ebe183e****
bodyobject

请求体参数。

nodepool_idstring

节点池 ID,添加节点时可以将该节点添加到指定的节点池中。

说明 如果不指定节点池 ID,默认将节点添加至默认节点池。
np1c9229d9be2d432c93f77a88fca0****
format_diskboolean

手动添加已有实例到集群时,是否对该实例进行数据盘挂载,将容器和镜像存储在数据盘上。取值:

  • true:对实例进行数据盘挂载,数据盘内原有数据将丢失,请注意备份数据。
  • false:不对实例进行数据盘挂载。

默认值:false

数据挂载规则:

  • 如果 ECS 已挂载数据盘,且最后一块数据盘的文件系统未初始化,系统会自动将该数据盘格式化为 ext4,用来存放内容/var/lib/docker、/var/lib/kubelet 。
  • 如果 ECS 未挂载数据盘,则不会挂载新的数据盘。
false
keep_instance_nameboolean

添加已有实到集群时,是否保留实例名称。如果不保留,则实例名称格式为worker-k8s-for-cs-<clusterid>。取值:

  • true:保留实例名称。
  • false:不保留实例名称,会用系统规则进行替换。

默认值:true

true
rds_instancesarray

如果指定了 RDS 实例列表,集群节点 ECS 会自动加入 RDS 访问白名单。

string

RDS 实例名称。

rm-xxx
archstring

节点 CPU 架构。支持的 CPU 架构包括amd64armarm64

默认值:amd64

说明 当集群类型为边缘托管版时必填。
amd64
optionsstring

节点的接入配置参数。

说明 当集群类型为边缘托管版时必填。
{"enableIptables": true,"manageRuntime": true,"quiet": true,"allowedClusterAddons": ["kube-proxy","flannel","coredns"]}

返回参数

名称类型描述示例值
string

节点接入脚本。

"\r\n\r\nwget http://aliacs-k8s-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/public/pkg/run/attach/1.26.3-aliyun.1/amd64/edgeadm -O edgeadm; chmod u+x edgeadm; ./edgeadm join --openapi-token=xxxxxx --node-spec=\"{\\\"allowedClusterAddons\\\":[\\\"kube-proxy\\\",\\\"flannel\\\",\\\"coredns\\\"],\\\"enableIptables\\\":true,\\\"interconnectMode\\\":\\\"basic\\\",\\\"labels\\\":{\\\"alibabacloud.com/image-accelerate-enabled\\\":\\\"true\\\",\\\"apps.openyurt.io/desired-nodepool\\\":\\\"npd8ffabb5a4d9453f94ba3cf6f06e6f0a\\\",\\\"foo\\\":\\\"bar\\\"},\\\"manageRuntime\\\":true,\\\"quiet\\\":true,\\\"runtime\\\":\\\"containerd\\\",\\\"runtime_version\\\":\\\"1.6.34\\\"}\" --region=cn-hangzhou"

示例

正常返回示例

JSON格式

"\"\\r\\n\\r\\nwget http://aliacs-k8s-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/public/pkg/run/attach/1.26.3-aliyun.1/amd64/edgeadm -O edgeadm; chmod u+x edgeadm; ./edgeadm join --openapi-token=xxxxxx --node-spec=\\\"{\\\\\\\"allowedClusterAddons\\\\\\\":[\\\\\\\"kube-proxy\\\\\\\",\\\\\\\"flannel\\\\\\\",\\\\\\\"coredns\\\\\\\"],\\\\\\\"enableIptables\\\\\\\":true,\\\\\\\"interconnectMode\\\\\\\":\\\\\\\"basic\\\\\\\",\\\\\\\"labels\\\\\\\":{\\\\\\\"alibabacloud.com/image-accelerate-enabled\\\\\\\":\\\\\\\"true\\\\\\\",\\\\\\\"apps.openyurt.io/desired-nodepool\\\\\\\":\\\\\\\"npd8ffabb5a4d9453f94ba3cf6f06e6f0a\\\\\\\",\\\\\\\"foo\\\\\\\":\\\\\\\"bar\\\\\\\"},\\\\\\\"manageRuntime\\\\\\\":true,\\\\\\\"quiet\\\\\\\":true,\\\\\\\"runtime\\\\\\\":\\\\\\\"containerd\\\\\\\",\\\\\\\"runtime_version\\\\\\\":\\\\\\\"1.6.34\\\\\\\"}\\\" --region=cn-hangzhou\""

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-25API 内部配置变更,不影响调用查看变更详情