如果购买ECS实例后需要将该云服务器添加到ACK集群中作为Worker节点,或移除Worker节点后需将节点实例重新加入节点池,您可以在调用本接口将已有ECS实例添加到ACK集群。
接口说明
调用本接口前,请仔细阅读使用限制,确保待添加的 ECS 实例满足条件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cs:AttachInstances | update | *Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId} |
| 无 |
请求语法
POST /clusters/{ClusterId}/attach HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 集群 ID。 | c106f377e16f34eb1808d6b9362c9**** |
body | object | 否 | 请求体参数。 | |
instances | array | 是 | 待添加的 ECS 实例列表信息。 | |
string | 否 | 待添加的 ECS 实例 ID。 | i-2zed0sswuau6o89b**** | |
key_pair | string | 否 | 待添加实例的密钥对名称。 key_pair 和 password 参数若要填写时,只需填写其中一个即可,或者两个参数均不填写。
指定 nodepool_id 后,该参数不支持。
| security-key |
password | string | 否 | 待添加实例的 SSH 登录密码。key_pair 和 password 参数若要填写时,只需填写其中一个即可,或者两个参数均不填写。 密码填写规范如下:
出于安全性考虑,密码传输过程中都会进行加密处理。 | Hello1234 |
format_disk | boolean | 否 | 是否将容器数据和镜像存储在数据盘中。取值如下:
默认值: 数据盘挂载规则:
当选择将数据存储至数据盘并且 ECS 已挂载数据盘,数据盘内原有数据将丢失,请注意备份数据。
| false |
keep_instance_name | boolean | 否 | 是否保留原实例名称。取值如下:
默认值: | false |
is_edge_worker | boolean | 否 | 待添加的节点是否为边缘节点,即 ENS 节点。取值:
默认值:
如果是边缘节点,取值必须是 true ,用于标识该节点类型为 ENS 节点。
| false |
nodepool_id | string | 否 | 节点池 ID。如果不指定,则将节点添加到默认节点池中。 | np615c0e0966124216a0412e10afe0**** |
image_id | string | 否 | 自定义镜像 ID。
指定 nodepool_id 后,该参数不支持。
| aliyun_2_1903_x64_20G_alibase_20200529.vhd |
cpu_policy | string | 否 | 节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略:
默认值:
指定 nodepool_id 后,该参数不支持。
| none |
user_data | string | 否 | 节点自定义数据。具体详情,请参见生成实例自定义数据。
指定 nodepool_id 后,该参数不支持。
| IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
rds_instances | array | 否 | RDS 实例列表。 | |
string | 否 | RDS 实例 ID。
指定 nodepool_id 后,该参数不支持。
| rm-67yawhau**** | |
runtime | runtime | 否 | 容器运行时。
指定 nodepool_id 后,该参数不支持。
name:容器运行时名称,ACK 支持以下三种容器运行时。
默认值:containerd。 containerd:容器运行时版本,默认为最新版。 关于安全沙箱运行时的变更详情,请参见安全沙箱运行时变更记录。 | |
tags | array | 否 | 节点标签。标签定义规则:
更多信息,请参见Labels and Selectors。
指定 nodepool_id 后,该参数不支持。
| |
tag | 否 | 节点标签。 |
返回参数
示例
正常返回示例
JSON
格式
{
"list": [
{
"code": "200",
"instanceId": "i-2ze0lgm3y6iylcbt****",
"message": "successful"
}
],
"task_id": "T-5a544aff80282e39ea00****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
变更时间 | 变更内容概要 | 操作 |
---|
除了调用本接口,您还可以通过控制台方式将 ECS 实例添加到 ACK 集群。具体操作,请参见将已有 ECS 实例添加到 ACK 集群。