更新节点池
更新时间 2022-12-02 21:48:28
最近更新时间: 2022-12-02 21:48:28
接口功能介绍
更新节点池配置信息。
接口约束
无
URI
POST /v1/cce/nodepool/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterID | 是 | String | d0dc8ddc8e3e11eca6200242ac110003 | 集群唯一ID | |
| nodePoolID | 是 | String | 7ba1921b-525a-8cfa-4a7c-428feea5ece8 | 节点池唯一ID | |
| nodePool | 是 | Object | {node-pool} | 节点池配置 | nodePool |
表nodePool
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 节点池名称 | node-pool1 | |
| kubernetes | 是 | Object | Kubernetes集群配置 | {kubernetes} | kubernetes |
| autoScaling | 是 | Object | 自动伸缩配置 | {autoscaling} | autoScaling |
| scalingGroup | 是 | Object | 弹性伸缩组配置 | {scaling-group} | scalingGroup |
表kubernetes
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| runtime | 是 | String | 容器运行时 | docker | |
| runtimeVersion | 否 | String | 容器运行时版本 | 19.03.5 | |
| cpuPolicy | 否 | String | 节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略： static：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。 none：表示启用现有的默认CPU亲和性方案。 默认值：none |
none | |
| labels | 否 | Map | 节点标签 | {"key1": "value1"} | |
| taints | 否 | Array | 节点污点，参看污点和容忍度 | [{taint1}, {taint2}] | |
| userData | 否 | String | 节点自定义数据 | dGhpcyBpcyBhIGV4YW1wbGU= |
表autoScaling
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| enable | 否 | Boolean | 是否启用自动伸缩，取值： true：开启节点池自动伸缩功能 false：不开启自动伸缩，当取值为false时，其他autoscaling配置参数将不生效 默认值：false |
true | |
| maxInstances | 是 | Integer | 自动伸缩组最大实例数 | 10 | |
| minInstances | 是 | Integer | 自动伸缩组最小实例数 | 1 | |
| type | 否 | String | 自动伸缩类型，按照自动伸缩实例类型划分。取值： cpu：普通实例型。 gpu：GPU实例型。 gpushare：GPU共享型。 spot：抢占式实例型。 默认值：cpu。 |
cpu |
表scalingGroup
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageID | 否 | String | 实例镜像ID | e4dcb80f-6fa5-1179-8819-82d75b8e03b1 | |
| imageName | 否 | String | 实例镜像名称 | cce-centos75-online | |
| billingMode | 是 | String | 节点池节点付费类型，取值： 1：包年包月。 2：按量付费。 默认值：1。 |
1 | |
| osType | 是 | String | 镜像系统类型： Linux Windows |
Linux | |
| instanceTypes | 是 | Array | 实例规格 | ["ecs.d1ne.2xlarge"] | |
| password | 否 | String | SSH登录密码，和KeyPairID二选一 | *** | |
| keyPairID | 是 | String | 免密登录密钥对名称，和Password二选一 | *** | |
| cycleCnt | 是 | Integer | 节点池节点包年包月时长 | 1 | |
| cycleType | 是 | String | 节点池节点付费周期，当指定为包年包月的时候需要指定周期： 3：月 5：年 |
3 | |
| scalingPolicy | 否 | String | 伸缩策略，取值： release：标准模式，根据申请资源值的使用量，通过创建、释放ECS的方式进行伸缩 recycle：极速模式，通过创建、停机、启动的方式进行伸缩，提高再次伸缩的速度（停机时计算资源不收费，只收取存储费用，本地盘机型除外） 默认值：release |
release | |
| securityGroupID | 否 | String | 安全组ID | d0dc8ddc8e3e11eca6200242ac110003 | |
| volumes | 是 | Array | 实例磁盘配置，volumes[0]为系统盘 | [{"type": "ssd", "size": 40}] | |
| subnetIDsInAZ | 是 | Array | 可用区子网 | [{subnet1}, {subnet2}] | subnetIDsInAZ |
| desiredSize | 否 | Integer | 节点池期望节点数量 | 0 |
表subnetIDsInAZ
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| azName | 是 | String | 可用区名字 | az1 | |
| subnetsIDs | 是 | Array | 子网ID列表 | ["1d0ed412-116c-f656-2964-af7e6f5547cc"] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功（800）或者失败（900） | 800 | |
| errorCode | String | 错误代码 | cce.nodepool.xxxx | |
| message | String | 错误信息的英文描述 | Invalid Request | |
| description | String | 错误信息的中文描述 | 错误请求 |
请求示例
请求体body
POST https://cck-global.ctapi.ctyun.cn/v1/cce/nodepool/update
Content-Type:application/json
{
"clusterID": "d0dc8ddc8e3e11eca6200242ac110003",
"nodePoolID" : "7ba1921b-525a-8cfa-4a7c-428feea5ece8",
"nodePool": {
"name": "cluster-demo",
"kubernetes" : {
"cpuPolicy": "none",
"labels": {
"key": "env",
"value": "prod"
},
"runtime": "docker",
"runtimeVersion": "19.03.5",
"taints": [
{
"key": "key",
"value": "value",
"effect": "NoSchedule"
}
],
"userData": "dGhpcyBpcyBhIGV4YW1wbGU="
},
"autoScaling" : {
"enable": true,
"maxInstances": 10,
"minInstances": 1,
"type": "cpu"
},
"scalingGroup" : {
"imageID": "d0dc8ddc8e3e11eca6200242ac110003",
"imageName": "cce-centos75-online",
"billingMode": "1",
"instanceTypes": ["ecs.d1ne.2xlarge"],
"keyPairID": "********",
"password": "********",
"cycleCnt": 1,
"cycleType": 3,
"securityGroupID": "d0dc8ddc8e3e11eca6200242ac110003",
"volumes": [
{
"type": "ssd",
"size": 40
}
],
"subnetIDsInAZ": [
{
"azName": "az1",
"subnetIDs": ["1d0ed412-116c-f656-2964-af7e6f5547cc"]
},
{
"azName": "az2",
"subnetIDs": ["1d0ed412-116c-f656-2964-af7e6f5547cc"]
},
{
"azName": "az3",
"subnetIDs": ["1d0ed412-116c-f656-2964-af7e6f5547cc"]
}
],
"desiredSize": 0
}
}
}
响应示例
正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"errorCode": ""
}
集群/节点池不存在返回示例
HTTP/1.1 404 NotFound
Content-Type:application/json
{
"statusCode": 900,
"errorCode": "cce.nodepool.notFound",
"message": "***",
"description": "***"
}
内部服务错误返回示例
HTTP/1.1 500 InternalServerError
Content-Type:application/json
{
"statusCode": 900,
"errorCode": "cce.nodepool.internalServerError",
"message": "***",
"description": "***"
}
