云容器引擎-查看所有集群列表
接口功能介绍
调用该接口查询集群列表。
接口约束
无
URI
GET /v1.1/ccse/clusters/page
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clusterName | 否 | String | 集群名称--- | ccse-demo | |
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 | 记录列表 | record | |
total | Integer | 总条数 | 10 | |
size | Integer | 每页条数 | 10 | |
current | Integer | 当前页码 | 1 | |
pages | Integer | 总页数 | 10 |
表 record
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
id | Long | 集群ID | 3 | |
clusterName | String | 集群名称 | test | |
clusterDesc | String | 集群描述 | ||
deployMode | String | 集群部署模式 | kubeadmin | |
clusterVersion | String | 集群版本 | 1.23.3 | |
clusterStatus | String | 集群状态,取值: normal:正常。 creating:创建中。 create_fail:创建失败。 adjust:规模调整中。 updating:升级中。 suspend:暂停。 deleting:删除中。 deleted:已删除。 delete_fail:删除失败。 resetting:节点重置中。 resettled:节点已重置。 reset_fail:节点重置失败。 upgrading:集群升级中。 upgrade_fail:集群升级失败。 |
normal | |
ipv4Ipv6 | String | IP协议版本,取值: ipv4:IPv4版本。 ipv6:IPv6版本。 |
ipv4 | |
controlPlaneProtocol | String | 控制面接口协议,取值: ipv4:IPv4版本。 ipv6:IPv6版本。 |
ipv4 | |
masterExtraVip | String | master外网VIP地址 | 192.168.1.28 | |
masterExtraVipv6 | String | master业务VIPv6地址,IPv6时填 | ||
masterIntraVip | String | master内网VIP地址 | 10.50.208.30 | |
masterIntraVipv6 | String | master管理VIPv6地址,IPv6时必填 | ||
securePort | Integer | ApiServer安全端口 | 6443 | |
nonSecurePort | Integer | ApiServer非安全端口,0表示不开启非安全端口 | 0 | |
startPort | Integer | 节点服务起始端口 | 30000 | |
endPort | Integer | 节点服务终止端口 | 32767 | |
serviceCidr | String | Service IP地址范围 | 10.96.0.0/16 | |
serviceCidrv6 | String | Service IPv6地址范围,IPv6时必填 | ||
podCidr | String | Pod IP地址范围 | 172.26.0.0/16 | |
podCidrv6 | String | Pod IPv6地址范围,IPv6时填 | ||
createdTime | String | 创建时间 | 2022-07-06 14:55:33 | |
modifiedTime | String | 修改时间 | 2023-06-25 10:01:41 | |
masterNodeNum | Integer | master节点数量 | 1 | |
slaveNodeNum | Integer | slave节点数量 | 3 | |
grafanaAddress | String | 监控面板grafana地址 | ||
bizState | Integer | 业务状态,1:运行中、2:已停止,参考:CS_CLUSTER_BIZ_STATE | ||
channelLabel | String | 渠道标签, yundao:云道 | ||
resPoolId | String | 资源池ID | ||
resPoolName | String | 资源池名称 | ||
eip | String | 集群绑定弹性ip | ||
timezone | String | 时区 | ||
containerRuntime | String | 容器运行时 | ||
networkPlugin | String | 网络插件 | ||
kubeProxyPattern | String | kube-proxy 代理模式 | ||
prodInstId | String | 平台实例ID | ||
prodId | String | 集群实例code | ||
expireTime | String | 到期时间 | ||
billMode | String | 订单类型 | ||
masterSlbIp | String | 集群slb ip | ||
vpcId | String | 集群所属VPC ID | ||
vpcName | String | 集群所属VPC名称 | ||
subnetUuid | String | 集群所属子网 |
枚举参数
无
请求示例
请求url
GET https://ccse-global.ctapi.ctyun.cn/v1.1/ccse/clusters/page?pageNow=1&pageSize=10&clusterName=test
请求头header
{
regionId:bb9fdb42056f11eda1610242ac110002
}
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询集群列表成功",
"returnObj": {
"records": [
{
"id": null,
"clusterName": "xx",
"clusterDesc": null,
"deployMode": "kubeadmin",
"clusterVersion": "1.17.3",
"clusterStatus": "abnormal",
"ipv4Ipv6": "ipv4",
"controlPlaneProtocol": "ipv4",
"masterIntraVip": "10.150.67.19",
"masterIntraVipv6": null,
"masterExtraVip": null,
"masterExtraVipv6": null,
"securePort": 6443,
"nonSecurePort": 0,
"startPort": 30000,
"endPort": 32767,
"serviceCidr": "10.96.0.0/16",
"serviceCidrv6": null,
"podCidr": "172.26.0.0/16",
"podCidrv6": null,
"channelLabel": null,
"createdTime": "2023-04-06 15: 17: 44",
"modifiedTime": "2023-06-14 14: 23: 47",
"masterNodeNum": 1,
"slaveNodeNum": 3,
"grafanaAddress": null
}
],
"total": 1,
"size": 10,
"current": 1,
"pages": 1
}
}