云容器引擎-查询节点池列表
接口功能介绍
调用该接口查看节点池列表。
接口约束
无
URI
GET /v1.1/ccse/clusters/*/nodePool/page
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clusterName | 是 | String | 集群名称 | ccse-demo |
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodePoolName | 否 | String | 节点池名称 | test | |
pageNow | 是 | Integer | 当前页码 | 1 | |
pageSize | 是 | Integer | 每页条数 | 10 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | 800 | |
message | String | 提示信息 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 错误码 | CCSE_500 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
records | Array of Objects | 记录列表 | records | |
total | Integer | 总条数 | 10 | |
size | Integer | 每页条数 | 10 | |
current | Integer | 当前页码 | 1 | |
pages | Integer | 总页数 | 1 |
表 records
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
id | Long | 节点池id | 1 | |
nodePoolName | String | 节点池名称 | test | |
billMode | String | 付费类型 | ||
description | String | 描述 | ||
nodeTotalNum | Integer | 节点总数 | 1 | |
normalNodeNum | Integer | 正常节点数 | 1 | |
unNormalNodeNum | Integer | 异常节点数 | 1 | |
nodes | Array of Objects | 节点池节点信息 | nodes | |
runtime | String | 运行时 | docker | |
runtimeVersion | String | 运行时版本 | 19.0 | |
nodeGroup | String | 伸缩组 | test-auto | |
vmSpecName | String | 节点规格 | s6.xlarge.2 | |
vmSpecId | Long | 节点规格id | 100 | |
vmType | String | 节点规格类型 | ||
cpu | Integer | cpu | 4 | |
memory | Integer | 内存 | 8 | |
dataDisks | Array of Objects | 数据盘 | dataDisks | |
status | String | 状态 | ||
maxPodNum | String | 最大pod数 | ||
labels | Map of String | 标签 | ||
taints | Array of Objects | 污点 | taints | |
isDefault | Boolean | 是否默认 | false | |
enableAutoScale | Boolean | 是否自动弹性伸缩 | true | |
maxNum | Integer | 伸缩组最大数量 | 9 | |
minNum | Integer | 伸缩组最小数量 | 0 | |
kubeletArgs | Map of String | kubelet参数 | ||
createdBy | Long | 创建人 | 123 | |
createdTime | String | 创建时间 | ||
updateBy | Long | 更新人 | 123 | |
updatedTime | String | 更新时间 |
表 nodes
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
clusterNodeId | Long | 集群节点id | 1 | |
hostId | Long | 主机id | 1 | |
clusterId | Long | 集群id | 1 | |
nodeName | String | 节点名称 | test | |
nodeType | Integer | 节点类型,取值: 1:master 2:slave |
1 | |
nodeStatus | String | 节点状态,取值: normal:健康。 abnormal:异常。 expulsion:驱逐中。 |
normal | |
isSchedule | Integer | 是否调度,取值: 1:是。 0:否。 |
1 | |
isEvict | Integer | 是否驱逐,取值: 1:是。 0:否。 |
0 | |
dockerDataPath | String | docker数据目录 | /data/kubelet | |
createdTime | String | 创建时间。 | 2023-01-01 01:01:01 | |
hostIp | String | 主机管理ip。 | 10.10.10.10 | |
hostIpv6 | String | 主机管理ipv6。 | ||
hostExtraIp | String | 主机业务ip。 | 10.10.10.10 | |
hostExtraIpv6 | String | 主机业务ipv6。 | ||
cpu | String | cpu核数 | 128 | |
cpuUseRate | Integer | cpu使用率% | 50 | |
memory | String | 内存 | 128 | |
memoryUseRate | Integer | 内存使用率% | 50 | |
disk | String | 磁盘GiB | 0 | |
diskUseRate | Integer | 磁盘使用率% | 0 | |
kubeletVersion | String | Kubelet 版本 | 1.23.3 | |
podCidr | String | Pod CIDR | ||
kernelVersion | String | 内核版本 | 4.19 | |
osImageVersion | String | OS 镜像 | ||
kubeProxyVersion | String | KubeProxy 版本 | 1.23.3 | |
dockerVersion | String | 容器版本 | 1.23.3 | |
isSecure | Integer | 是否安全节点,取值: 1:是。 0:否。 |
0 | |
taints | Array of Objects | 污点 | taints | |
channelLabel | String | 渠道标签 | ||
zoneId | String | 可用区id | ||
zoneName | String | 可用区名称 | ||
cloudHostId | String | 云主机id | ||
nodePoolId | Long | 节点池id | 12345 | |
labels | Map of String | 标签 | ||
ecsId | String | paas平台云主机id | ||
vmSpecName | String | 节点规格名称 |
表 dataDisks
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
diskSpecId | Long | 数据盘规格id | 1 | |
diskSpecName | String | 数据盘规格名称 | SAS | |
size | Long | 数据盘大小 | 100 |
表 taints
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
key | String | 键 | xx | |
value | String | 值 | xx | |
effect | String | 策略 | NoSchedule |
枚举参数
无
请求示例
请求url
GET https://ccse-global.ctapi.ctyun.cn/v1.1/ccse/clusters/ccse-demo/nodePool/page?nodePoolName=xx&pageNow=1&pageSize=10
请求头header
{regionId:bb9fdb42056f11eda1610242ac110002}
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询集群ccse-demo节点池成功",
"returnObj": {
"records": [
{
"id": "10000000000000",
"nodePoolName": "test-auto",
"billMode": null,
"description": "",
"nodeTotalNum": 1,
"normalNodeNum": 1,
"unNormalNodeNum": 0,
"nodes": [
{
"clusterNodeId": 3,
"hostId": 1,
"clusterId": 3,
"nodeName": "10.10.10.10",
"nodeType": 1,
"nodeStatus": "normal",
"isSchedule": 1,
"isEvict": 0,
"dockerDataPath": "/ccse/data/kubelet",
"createdTime": "2022-07-06 14: 55: 33",
"hostIp": "10.10.10.10",
"hostIpv6": null,
"hostExtraIp": null,
"hostExtraIpv6": null,
"cpu": "128",
"cpuUseRate": 17,
"memory": "256",
"memoryUseRate": 65,
"disk": "0",
"diskUseRate": 0,
"kubeletVersion": null,
"podCidr": null,
"kernelVersion": null,
"osImageVersion": null,
"kubeProxyVersion": null,
"dockerVersion": null,
"isSecure": 0,
"taints": null,
"channelLabel": null,
"zoneId": null,
"zoneName": null,
"cloudHostId": null,
"nodePoolId": "10000000000000",
"labels": null,
"ecsId": null
}
],
"runtime": null,
"runtimeVersion": null,
"nodeGroup": "test-auto",
"vmSpecName": "4 vCpus| 8GB",
"vmSpecId": 100000,
"vmType": "",
"cpu": 4,
"memory": 8,
"dataDisks": [
{
"diskSpecId": 2,
"diskSpecName": "SAS",
"size": 100
}
],
"status": "normal",
"maxPodNum": null,
"labels": {
"test": "test"
},
"taints": [
{
"key": "xx",
"value": "xx",
"effect": "NoSchedule"
}
],
"isDefault": false,
"enableAutoScale": true,
"maxNum": 9,
"minNum": 0,
"kubeletArgs": null,
"createdBy": 1,
"createdTime": "2023-04-17 17: 51: 30",
"updatedBy": 1,
"updatedTime": "2023-04-28 14: 36: 04"
}
],
"total": 1,
"size": 10,
"current": 1,
"pages": 1
}
}