AttachInstances - 添加已有ECS实例到集群

更新时间:2025-03-26 04:00:27

如果购买ECS实例后需要将该云服务器添加到ACK集群中作为Worker节点,或移除Worker节点后需将节点实例重新加入节点池,您可以在调用本接口将已有ECS实例添加到ACK集群。

接口说明

调用本接口前,请仔细阅读使用限制,确保待添加的 ECS 实例满足条件。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

集群 ID。

c106f377e16f34eb1808d6b9362c9****
bodyobject

请求体参数。

instancesarray

待添加的 ECS 实例列表信息。

string

待添加的 ECS 实例 ID。

i-2zed0sswuau6o89b****
key_pairstring

待添加实例的密钥对名称。 key_pair 和 password 参数若要填写时,只需填写其中一个即可,或者两个参数均不填写。

说明
指定nodepool_id后,该参数不支持。
security-key
passwordstring

待添加实例的 SSH 登录密码。key_pair 和 password 参数若要填写时,只需填写其中一个即可,或者两个参数均不填写。

密码填写规范如下:

  • 长度为 8~30 个字符
  • 至少同时包含大小写字母、数字和特殊符号
  • 不支持反斜线(\)和半角双引号(")两个符号

出于安全性考虑,密码传输过程中都会进行加密处理。

Hello1234
format_diskboolean

是否将容器数据和镜像存储在数据盘中。取值如下:

  • true:将容器数据和镜像存储在数据盘。

  • false:不将容器数据和镜像存储在数据盘。

默认值:false

数据盘挂载规则:

  • 如果 ECS 已挂载数据盘,且最后一块数据盘的文件系统未初始化,系统会自动将该数据盘格式化为 EXT4,用来存放内容/var/lib/docker、/var/lib/kubelet(分别为 Docker 容器运行时和 kubelet 组件默认对应的数据目录)。
  • 如果 ECS 未挂载数据盘,则不会挂载新的数据盘。
说明
当选择将数据存储至数据盘并且 ECS 已挂载数据盘,数据盘内原有数据将丢失,请注意备份数据。
false
keep_instance_nameboolean

是否保留原实例名称。取值如下:

  • true:保留实例名称。

  • false:不保留实例名称。

默认值:false

false
is_edge_workerboolean

待添加的节点是否为边缘节点,即 ENS 节点。取值:

  • true:表示添加的节点是边缘节点。

  • false:表示添加的节点是不是边缘节点。

默认值:false

说明
如果是边缘节点,取值必须是true,用于标识该节点类型为 ENS 节点。
false
nodepool_idstring

节点池 ID。如果不指定,则将节点添加到默认节点池中。

np615c0e0966124216a0412e10afe0****
image_idstring

自定义镜像 ID。

  • 如果指定自定义镜像 ID,实例系统盘镜像将被替换为该自定义镜像。

  • 如果不指定,则使用默认系统镜像。

说明
指定nodepool_id后,该参数不支持。
aliyun_2_1903_x64_20G_alibase_20200529.vhd
cpu_policystring

节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略:

  • static:允许为节点上具有某些资源特征 Pod 增强其 CPU 亲和性和独占性。
  • none:表示启用现有的默认 CPU 亲和性方案。

默认值:none

说明
指定nodepool_id后,该参数不支持。
none
user_datastring

节点自定义数据。具体详情,请参见生成实例自定义数据

说明
指定nodepool_id后,该参数不支持。
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi
rds_instancesarray

RDS 实例列表。

string

RDS 实例 ID。

说明
指定nodepool_id后,该参数不支持。
rm-67yawhau****
runtimeruntime

容器运行时。

说明
指定nodepool_id后,该参数不支持。

name:容器运行时名称,ACK 支持以下三种容器运行时。

  • containerd:推荐使用,支持所有集群版本。
  • Sandboxed-Container.runv:安全沙箱容器,提供更高的隔离性,支持 1.24 版本及以下集群。
  • docker:支持 1.22 版本及以下集群。

默认值:containerd。

containerd:容器运行时版本,默认为最新版。

关于安全沙箱运行时的变更详情,请参见安全沙箱运行时变更记录

tagsarray

节点标签。标签定义规则:

  • 标签由区分大小写的键值对(key-value)组成,您最多可以设置 20 个标签。
  • 标签键不可以重复,最长为 64 个字符;
  • 标签值可以为空,最长为 128 个字符。
  • 标签键和标签值都不能以`aliyunacs:https://http://`开头。

更多信息,请参见Labels and Selectors

说明
指定nodepool_id后,该参数不支持。
tag

节点标签。

返回参数

名称类型描述示例值
名称类型描述示例值
object

返回体参数。

listarray<object>

节点添加信息列表。

listobject

节点添加结果详情。

codestring

节点添加结果状态码。

200
instanceIdstring

ECS 实例 ID。

i-2ze0lgm3y6iylcbt****
messagestring

节点添加结果描述信息。

successful
task_idstring

任务 ID。

T-5a544aff80282e39ea00****

示例

正常返回示例

JSON格式

{
  "list": [
    {
      "code": "200",
      "instanceId": "i-2ze0lgm3y6iylcbt****",
      "message": "successful"
    }
  ],
  "task_id": "T-5a544aff80282e39ea00****"
}

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史

除了调用本接口,您还可以通过控制台方式将 ECS 实例添加到 ACK 集群。具体操作,请参见将已有 ECS 实例添加到 ACK 集群

  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等