列举节点池
更新时间 2022-12-02 21:48:30
最近更新时间: 2022-12-02 21:48:30
接口功能介绍
查询集群内所有节点池详情。
接口约束
无
URI
GET /v1/cce/nodepool/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterID | 是 | String | 集群唯一ID | d0dc8ddc8e3e11eca6200242ac110003 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功（800）或者失败（900） | 800 | |
| errorCode | String | 错误代码 | cce.nodepool.xxxx | |
| message | String | 错误信息的英文描述 | Invalid Request | |
| description | String | 错误信息的中文描述 | 错误请求 | |
| returnObj | Array | 返回节点池数组 | [{node-pool1}, {node-pool2}] | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 节点池名称 | node-pool1 | |
| nodePoolID | String | 节点池ID | d0dc8ddc8e3e11eca6200242ac110003 | |
| regionID | String | 节点池所在区域ID | 4d21b6b4-b0e1-207e-0c2c-d2f347c2207e | |
| regionName | String | 节点池所在区域名称 | neimeng8 | |
| kubernetes | Object | Kubernetes集群配置 | {kubernetes} | kubernetes |
| autoScaling | Object | 自动伸缩配置 | {autoscaling} | autoScaling |
| scalingGroup | Object | 弹性伸缩组配置 | {scaling-group} | scalingGroup |
| status | Object | 节点池状态 | {status} | status |
表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 | |
| 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 |
| scalingGroupID | String | 弹性伸缩组ID | 1bb18ab5-48ee-099b-40db-a9742146ae21 | |
| scalingPolicy | String | 伸缩策略，取值： release：标准模式，根据申请资源值的使用量，通过创建、释放ECS的方式进行伸缩 recycle：极速模式，通过创建、停机、启动的方式进行伸缩，提高再次伸缩的速度（停机时计算资源不收费，只收取存储费用，本地盘机型除外） 默认值：release |
release | |
| desiredSize | Integer | 节点池期望节点数量 | 0 |
表subnetIDsInAZ
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| azName | String | 可用区名字 | az1 | |
| subnetsIDs | Array | 子网ID列表 | ["1d0ed412-116c-f656-2964-af7e6f5547cc"] |
表status
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| failedNodes | Integer | 失败实例数 | 0 | |
| healthyNodes | Integer | 处于健康状态实例数 | 0 | |
| initialNodes | Integer | 正在创建的节点数 | 0 | |
| offlineNodes | Integer | 离线节点数 | 0 | |
| removingNodes | Integer | 正在被移除的点数 | 0 | |
| servingNodes | Integer | 处于工作状态的节点数 | 0 | |
| totalNodes | Integer | 节点池内节点数量 | 0 | |
| state | String | 节点池状态，取值： active：已激活 scaling：伸缩中 removing：节点移除中 deleting：删除中 updating：更新中 |
active |
请求示例
GET https://cck-global.ctapi.ctyun.cn/v1/cce/nodepool/list?clusterID=d0dc8ddc8e3e11eca6200242ac110003
Content-Type:application/json
响应示例
正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"errorCode": "",
"returnObj": [
{
"name": "cluster-demo",
"nodePoolID": "348e291b-bf5c-70f9-bfb8-d60dd2c7c5b5",
"regionID": "4d21b6b4-b0e1-207e-0c2c-d2f347c2207e",
"regionName": "neimeng8",
"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"]
}
],
"scalingGroupID": "1bb18ab5-48ee-099b-40db-a9742146ae21",
"scalingPolicy": "release",
"desiredSize": 0
},
"status": {
"failedNodes" : 0,
"healthyNodes" : 3,
"initialNodes" : 0,
"offlineNodes" : 0,
"removingNodes" : 0,
"servingNodes" : 3,
"totalNodes" : 3,
"state" : "active"
}
}
]
}
内部服务错误返回示例
HTTP/1.1 500 InternalServerError
Content-Type:application/json
{
"statusCode": 900,
"errorCode": "cce.nodepool.internalServerError",
"message": "***",
"description": "***"
}
