说明:当前页面接口为旧版 API,未来可能停止维护。容器服务 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 容器服务 API 3.0。
接口描述
本接口 ( AddClusterInstancesFromExistedCvm ) 用于添加已存在的云服务器到集群。
接口请求域名:
ccs.api.qcloud.com
- 当集群 status 为 Running 时,才能调用此接口。
- 当前云服务器状态为正常或关机,才能调用此接口。具体可以参考 查看实例列表 页面中的实例状态列表。
- 当前云服务器会被重装,系统与创建集群时指定的系统相同,请确保系统盘中无重要文件。
- 添加的云服务器必须与当前集群在同一个 VPC 中。
输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数。
参数名称 | 描述 | 类型 | 必选 |
---|---|---|---|
clusterId | 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段。 | String | 是 |
instanceIds | 请填写 查看实例列表 接口中返回的 unInstanceId ( 实例 ID )字段。 | String | 是 |
password | 实例密码。未设置则为随机产生,并通过站内信下发。
|
String | 否 |
keyId | 密钥 ID。关联密钥后可使用密钥登录实例,keyId 可通过接口 查询密钥 获取,密钥与密码不能同时指定,同时 Windows 操作系统不支持指定密钥。 | String | 否 |
sgId | 安全组 ID,安全组必须属于集群新增资源所属项目下。默认为不绑定任何安全组,请填写 查询安全组列表 接口中返回的 sgId 字段。 | String | 否 |
osName | 系统名。centos7.2x86_64 或者 ubuntu16.04.1 LTSx86_64,仅当新建集群为空集群,第一次向空集群添加节点时需要指定。当集群系统确定后,后续添加的节点都是集群系统。 | String | 否 |
mountTarget | 数据盘挂载点,默认不挂载数据盘。已格式化的 ext3,ext4,xfs 文件系统的数据盘将直接挂载,其他文件系统或未格式化的数据盘将自动格式化为 ext4 并挂载。请注意备份数据,无数据盘或有多块数据盘的云服务器此设置不生效。 | String | 否 |
dockerGraphPath | dockerd --graph 指定值, 默认为/var/lib/docker。 | String | 否 |
unschedulable | 设置加入的节点是否参与调度,默认值为 0,表示参与调度;非 0 表示不参与调度,待节点初始化完成之后,可执行 kubectl uncordon nodename 使 node 加入调度。 | Int | 否 |
userScript | base64 编码的用户脚本,此脚本会在 k8s 组件运行后执行,需要用户保证脚本的可重入及重试逻辑,脚本及其生成的日志文件可在节点的/data/ccs_userscript/路径查看,如果要求节点需要在进行初始化完成后才可加入调度,可配合 unschedulable 参数使用,在 userScript 最后初始化完成后,添加 kubectl uncordon nodename --kubeconfig=/root/.kube/config 命令使节点加入调度。 | String | 否 |
monitorService | 是否安装云产品监控组件。0表示不安装,1表示安装,默认为1。 | Int | 否 |
securityService | 是否安装云安全组件。0表示不安装,1表示安装,默认为1。 | Int | 否 |
输出参数
参数名称 | 描述 | 类型 |
---|---|---|
code | 公共错误码。0 表示成功,其他值表示失败。 | Int |
codeDesc | 业务错误码。成功时返回 Success,错误时返回具体业务错误原因。 | String |
message | 模块错误信息描述,与接口相关。详见 错误返回结果。 | String |
succInstanceIds | 成功加入集群的云服务器列表。 | Obj Array |
faliInstanceIds | 失败加入集群的云服务器列表。 | Obj Array |
faliInstanceIds 字段详细信息:
参数名称 | 描述 | 类型 |
---|---|---|
instanceId | 实例 ID | String |
message | 失败原因 | String |
示例
输入
https://domain/v2/index.php?Action=AddClusterInstancesFromExistedCvm
&clusterId=clus-xxxxx
&instanceIds.0=ins-xxxxxx
&instanceIds.1=ins-xxxxxx
&其它公共参数
输出
{
"code" : 0,
"message" : "ok",
"codeDesc": "Success",
"data":{
"succInstanceIds":["ins-xxxxxx","ins-xxxxxx"],
"faliInstanceIds":null
}
}