调用AttachInstances添加已有ECS实例到集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求语法
POST /clusters/ClusterId/attach HTTP/1.1
Content-Type:application/json
{
"instances" : [ "String" ],
"key_pair" : "String",
"password" : "String",
"format_disk" : Boolean,
"keep_instance_name" : Boolean,
"is_edge_worker" : Boolean,
"nodepool_id" : "String",
"image_id" : "String",
"cpu_policy" : "String",
"user_data" : "String",
"rds_instances" : [ "String" ],
"runtime" : {
"name" : "String",
"version" : "String"
},
"tags" : [ {
"key" : "String",
"value" : "String"
} ]
}
请求参数
请求Path参数
参数名称 |
类型 |
是否必选 |
示例 |
说明 |
ClusterId | String | 是 | c106f377e16f34eb1808d6b9362c9**** | 集群ID。 |
请求Body参数
参数名称 |
类型 |
是否必选 |
示例 |
说明 |
instances | Array of String | 是 | i-2zed0sswuau6o89b**** | 待添加的实例ID。 |
key_pair | String | 否 | security-key | 待添加实例的密钥对名称,和 说明
指定 |
password | String | 否 | Hello1234 | 待添加实例的SSH登录密码,和 出于安全性考虑,密码传输过程中都是经过加密处理的。 |
format_disk | Boolean | 否 | false | 是否将容器数据和镜像存储在数据盘中。取值:
默认值: 数据盘挂载规则:
|
keep_instance_name | Boolean | 否 | false | 是否保留原实例名称。取值:
默认值: |
is_edge_worker | Boolean | 否 | false | 是否为边缘节点,即ENS节点。取值:
默认值: 说明
如果是边缘节点,取值必须是 |
nodepool_id | String | 否 | np615c0e0966124216a0412e10afe0**** | 节点池ID。如果不指定,则将节点添加到默认节点池中。 |
image_id | String | 否 | aliyun_2_1903_x64_20G_alibase_20200529.vhd | 自定义镜像ID,如果不传则使用默认系统镜像。 说明
|
cpu_policy | String | 否 | none | 节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略:
默认值: 说明
指定 |
user_data | String | 否 | IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi | 节点自定义数据。更多详情,请参见生成实例自定义数据。 说明
指定 |
rds_instances | Array of String | 否 | rm-67yawhau**** | RDS实例ID。 说明
指定 |
runtime | runtime | 否 | 容器运行时。 说明
指定 |
|
tags | Array of tag | 否 | 节点标签。标签定义规则:
|
响应体语法
HTTP/1.1 200 OK
Content-Type:application/json
{
"list" : [ {
"code" : "String",
"instanceId" : "String",
"message" : "String"
} ],
"task_id" : "String"
}
响应参数
响应Body参数
参数名称 |
类型 |
示例 |
说明 |
list | Array of list | 节点添加信息列表。 |
|
code | String | 200 | 节点添加结果状态码。 |
instanceId | String | i-2ze0lgm3y6iylcbt**** | 实例ID。 |
message | String | successful | 节点添加结果描述信息。 |
task_id | String | T-5a544aff80282e39ea000039 | 任务ID。 |
添加已有实例到集群示例
请求示例
POST /clusters/c106f377e16f34eb1808d6b9362c9****/attach HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json
{
"instances" : [ "i-2zed0sswuau6o89b****" ],
"key_pair" : "security-key",
"password" : "Hello1234",
"format_disk" : false,
"keep_instance_name" : false,
"is_edge_worker" : false,
"nodepool_id" : "np615c0e0966124216a0412e10afe0****",
"image_id" : "aliyun_2_1903_x64_20G_alibase_20200529.vhd",
"cpu_policy" : "none",
"user_data" : "IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi",
"rds_instances" : [ "rm-67yawhau****" ],
"runtime" : {
"name" : "docker",
"version" : "19.03.5"
},
"tags" : [ {
"key" : "env",
"value" : "prod"
} ]
}
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AttachInstancesResponse>
<list>
<code>200</code>
<instanceId>i-2ze0lgm3y6iylcbt****</instanceId>
<message>successful</message>
</list>
<task_id>T-5a544aff80282e39ea000039</task_id>
</AttachInstancesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"list" : [ {
"code" : "200",
"instanceId" : "i-2ze0lgm3y6iylcbt****",
"message" : "successful"
} ],
"task_id" : "T-5a544aff80282e39ea000039"
}
错误码
访问错误中心查看更多错误码。
开发者资源
-
SDK
阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证。
-
OpenAPI Explorer
快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。
-
阿里云CLI
阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。
- 本页导读 (1)