同步节点池

project_id

是

String

参数解释：

项目ID，获取方式请参见如何获取接口URI中参数。

约束限制：

不涉及

取值范围：

账号的项目ID

默认取值：

不涉及

cluster_id

是

String

参数解释：

集群ID，获取方式请参见如何获取接口URI中参数。

约束限制：

不涉及

取值范围：

集群ID

默认取值：

不涉及

nodepool_id

是

String

参数解释：

选择需要同步/升级的节点池，

约束限制：

不涉及

取值范围：

• 节点池ID：同步指定节点池中的配置，节点池ID获取方式请参见如何获取接口URI中参数。

• DefaultPool：升级默认节点池的配置

默认取值：

不涉及

Content-Type

是

String

参数解释：

消息体的类型（格式），默认为application/json，有其他取值时会在具体接口中专门说明。

约束限制：

GET方法不做校验

取值范围：

不涉及

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

kind

否

String

参数解释：

API类型。

约束限制：

该值不可修改。

取值范围：

不涉及

默认取值：

NodePool

apiVersion

否

String

参数解释：

API版本。

约束限制：

该值不可修改

取值范围：

不涉及

默认取值：

v3

metadata

否

NodePoolMetadata object

节点池的元数据信息

spec

是

UpgradeNodePoolSpec object

参数解释：

同步节点池请求详细参数

约束限制：

不涉及

name

是

String

参数解释：

节点名池名称。

约束限制：

不允许创建名为 DefaultPool 的节点池。

取值范围：

以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围1-63位，且不能以中划线(-)结尾。

默认取值：

不涉及

uid

否

String

参数解释：

节点池的uid。

约束限制：

创建成功后自动生成，填写无效。

取值范围：

不涉及

默认取值：

不涉及

annotations

否

Map<String,String>

参数解释：

节点池的注解，以key value对表示。

约束限制：

仅用于查询，不支持请求时传入，填写无效。

updateTimestamp

否

String

参数解释：

节点池更新时间。

约束限制：

更新节点池时自动记录，不支持传入。

取值范围：

不涉及

默认取值：

不涉及

creationTimestamp

否

String

参数解释：

节点池创建时间。

约束限制：

创建节点池时自动记录，不支持传入。

取值范围：

不涉及

默认取值：

不涉及

resourceVersion

否

Integer

参数解释：

节点池最后更新时间的时间戳。

约束限制：

创建节点池时自动记录，不支持传入。

取值范围：

不涉及

默认取值：

不涉及

maxUnavailable

是

Integer

参数解释：

每批最大同步节点。节点升级时，允许节点不可用的最大数量。节点重置方式进行同步时节点将不可用，请合理设置该参数，尽量避免出现集群节点不可用数量过多导致Pod无法调度的情况。

约束限制：

不涉及

取值范围：

取值范围[1-20]

默认取值：

不涉及

nodeIDs

否

Array of strings

参数解释：

本次操作同步的节点池中选择的节点ID列表，获取方式请参见如何获取接口URI中参数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

nodePoolID

是

String

参数解释：

节点池ID，获取方式请参见如何获取接口URI中参数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

nodeTemplate

否

UpgradeNodePoolSpecNodeTemplate object

参数解释：

同步节点池模板参数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

lifeCycle

是

NodeLifecycleConfig object

参数解释：

节点自定义生命周期配置

约束限制：

仅当nodePoolID为DefaultPool时该字段生效，自定义节点池同步时以节点池配置为准。

login

是

Login object

参数解释：

节点的登录方式。密钥对和密码登录方式二者必选其一。

约束限制：

不涉及

volumeConfig

否

VolumeConfig object

参数解释：

节点池同步场景磁盘配置。

约束限制：

不涉及

preInstall

否

String

参数解释：

安装前执行脚本。

约束限制：

安装前/后执行脚本统一计算字符，转码后的字符总数不能超过10240。

输入的值需要经过Base64编码，方法如下：

echo -n "待编码内容" | base64

取值范围：

不涉及

默认取值：

不涉及

postInstall

否

String

参数解释：

安装后执行脚本。

约束限制：

安装前/后执行脚本统一计算字符，转码后的字符总数不能超过10240。

输入的值需要经过Base64编码，方法如下：

echo -n "待编码内容" | base64

取值范围：

不涉及

默认取值：

不涉及

waitPostInstallFinish

否

Boolean

参数解释：

该参数用于控制重置/纳管/批量重置节点时， post-install脚本执行完成前允许节点调度 的行为。当操作的节点属于节点池时，以节点池相关配置为准。当该参数未设置或者为false时，在kubernetes节点就绪时，容器即可被调度到可用节点。当该参数为true时，在kubernetes节点就绪时且post-install脚本执行完成时，容器才可被调度到可用节点。

约束限制：

不涉及

取值范围：

• false：在kubernetes节点就绪时，容器即可被调度到可用节点。

• true：在kubernetes节点就绪时且post-install脚本执行完成时，容器才可被调度到可用节点。

默认取值：

false

sshKey

否

String

参数解释：

选择密钥对方式登录时的密钥对名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

userPassword

否

UserPassword object

参数解释：

选择密码方式登录时的账号密码信息，之后可通过此账号密码登录节点。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

removeUserPassword

否

Boolean

参数解释：

更新节点池时，移除当前节点池密码方式登录的配置

约束限制：

仅更新节点池场景支持该参数，设置为true时不允许设置userPassword

取值范围：

不涉及

默认取值：

false

removeSSHKey

否

Boolean

参数解释：

更新节点池时，移除当前节点池密钥对方式登录的配置

约束限制：

仅更新节点池场景支持该参数，设置为true时不允许设置sshKey

取值范围：

不涉及

默认取值：

false

username

否

String

参数解释：

登录账号，默认为“root”。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

root。

password

是

String

参数解释：

登录密码，若创建节点通过用户名密码方式，即使用该字段，则响应体中该字段作屏蔽展示。

约束限制：

创建节点时password字段需要加盐加密，具体方法请参见创建节点时password字段加盐加密。

取值范围：

密码复杂度要求：

• 长度为8-26位。

• 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?）中的三种。

• 密码不能包含用户名或用户名的逆序。

默认取值：

不涉及

volumeResetPolicy

否

String

参数解释：

节点重置时磁盘数据的保留策略。

不传或该字段为空时，默认使用reset_managed_volumes策略清空由CCE管理的数据盘。

约束限制：

当保留自定义挂载卷时，挂载到指定目录与作为持久存储卷的高级配置不允许修改。

取值范围：

• reset_managed_volumes：清空由CCE管理的数据盘。

• retain_custom_volumes：保留用户自定义挂载卷（包括挂载到指定目录的卷和用作本地持久卷的卷），集群版本需为v1.29.15-r90、v1.30.14-r90、v1.31.14-r50、v1.32.13-r20、v1.33.12-r0、v1.34.8-r0、v1.35.5-r0、v1.36.1-r10或以上版本。

默认取值：

reset_managed_volumes

jobid

String

参数解释：

提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。

取值范围：

不涉及

200

表示获取任务信息成功。