同步节点池
功能介绍
该API用于同步节点池中已有节点的配置

URI
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/operation/upgrade
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
cluster_id |
是 |
String |
参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
nodepool_id |
是 |
String |
参数解释: 节点池ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 节点池ID 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式) 约束限制: GET方法不做校验 取值范围:
默认取值: 不涉及 |
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
spec |
是 |
UpgradeNodePoolSpec object |
同步节点池请求详细参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
maxUnavailable |
是 |
Integer |
每批最大同步节点,取值范围[1-20]。节点升级时,允许节点不可用的最大数量。节点重置方式进行同步时节点将不可用,请合理设置该参数,尽量避免出现集群节点不可用数量过多导致Pod无法调度的情况。 |
nodeIDs |
否 |
Array of strings |
本次操作同步的节点池中选择的节点ID列表,获取方式请参见如何获取接口URI中参数。 |
nodePoolID |
是 |
String |
节点池ID,获取方式请参见如何获取接口URI中参数。 |
nodeTemplate |
否 |
同步节点池模板参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
lifeCycle |
是 |
NodeLifecycleConfig object |
节点自定义生命周期配置 |
login |
是 |
Login object |
参数解释: 节点的登录方式。密钥对和密码登录方式二者必选其一。 约束限制: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
preInstall |
否 |
String |
安装前执行脚本。安装前/后执行脚本统一计算字符,转码后的字符总数不能超过10240。 输入的值需要经过Base64编码,方法如下: echo -n "待编码内容" | base64 |
postInstall |
否 |
String |
安装后执行脚本。安装前/后执行脚本统一计算字符,转码后的字符总数不能超过10240。 输入的值需要经过Base64编码,方法如下: echo -n "待编码内容" | base64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sshKey |
否 |
String |
参数解释: 选择密钥对方式登录时的密钥对名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
userPassword |
否 |
UserPassword object |
参数解释: 选择密码方式登录时的账号密码信息,之后可通过此账号密码登录节点。 约束限制: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
username |
否 |
String |
参数解释: 登录账号,默认为“root”。 约束限制: 不涉及 取值范围: 不涉及 默认取值: root。 |
password |
是 |
String |
参数解释: 登录密码,若创建节点通过用户名密码方式,即使用该字段,则响应体中该字段作屏蔽展示。 约束限制: 创建节点时password字段需要加盐加密,具体方法请参见创建节点时password字段加盐加密。 取值范围: 密码复杂度要求:
默认取值: 不涉及 |
响应参数
状态码:200
表示节点池同步已经被接受
无
请求示例
-
同步节点池(自建节点池)
{ "spec" : { "maxUnavailable" : 1, "nodeIDs" : [ "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", "bbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbb" ], "nodePoolID" : "cccccccc-cccc-cccc-cccc-cccccccccccc" } }
-
同步节点池(默认节点池)
{ "spec" : { "maxUnavailable" : 1, "nodeIDs" : [ "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", "bbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbb" ], "nodePoolID" : "DefaultPool", "nodeTemplate" : { "lifeCycle" : { "preInstall" : "ZWNobyAx", "postInstall" : "ZWNobyAx" }, "login" : { "userPassword" : { "password" : "xxxxx", "username" : "root" } } } } }
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
表示节点池同步已经被接受 |
错误码
请参见错误码。