平台中心
首页 / API 文档 / 平台管理 / 集群管理 / 集群基础操作 / 查看集群详情

查看集群详情

请求信息

请求行

GET /apis/platform.tkestack.io/v1/clusters/{name}

查看指定的集群的详细信息。

请求行参数

名称 类型 是否必填项 描述
name string 是集群的名称。

请求参数

名称 类型 是否必填项 描述
exact boolean 否服务出口是否要确切定义。不推荐使用，计划将会在 1.18 版本移除。
export boolean 否是否应导出该值。 用户无法指定导出的字段。 不推荐使用。 计划在 1.18 版本中移除。
pretty string 否如果为 true，则会将返回结果输出成适合打印的格式。

返回信息

Content-Type application/json, application/yaml, application/vnd.kubernetes.protobuf

状态码: 200

OK

返回体示例

Kubernetes 集群。

{
   "apiVersion": "platform.tkestack.io/v1",
   "kind": "Cluster",
   "metadata": {
     "annotations": {
       "cpaas.io/network-type": "kube-ovn",
       "platform.tkestack.io/galaxy-ipam-ip": "10.96.0.8",
       "platform.tkestack.io/gpu-quota-admission-ip": "10.96.0.9"
     },
     "creationTimestamp": "2021-06-21T04:10:33Z",
     "labels": {
       "cluster-type": "Baremetal",
       "cpaas.io/arch": "amd64"
     },
     "name": "global",
     "resourceVersion": "11982192",
     "selfLink": "/apis/platform.tkestack.io/v1/clusters/global",
     "uid": "6cc56a49-8ac3-45ea-916c-10fb67b9472b"
   },
   "spec": {
     "clusterCIDR": "10.199.0.0/16",
     "clusterCredentialRef": {
       "name": "cc-global"
     },
     "displayName": "Global",
     "dnsDomain": "cluster.local",
     "etcd": {
       "local": {
         "dataDir": "/var/lib/etcd",
         "serverCertSANs": [
           "etcd",
           "etcd.kube-system",
           "192.168.0.100"
         ]
       }
     },
     "features": {
       "enableMasterSchedule": true,
       "files": [
         {
           "dst": "/etc/kubernetes/audit/policy.yaml",
           "src": "/app/provider/baremetal/audit/policy.yaml"
         }
       ],
       "ha": {
         "thirdParty": {
           "vip": "192.168.0.100",
           "vport": 6443
         }
       },
       "ipvs": true,
       "skipConditions": [
         "EnsureGalaxy",
         "EnsureNvidiaDriver",
         "EnsureKubernetesImages",
         "EnsureMetricsServer"
       ],
       "upgrade": {
         "mode": "Auto",
         "strategy": {
           "drainNodeBeforeUpgrade": false,
           "maxUnready": 0
         }
       }
     },
     "finalizers": [
       "cluster"
     ],
     "kubeletExtraArgs": {
       "max-pods": "110"
     },
     "machines": [
       {
         "displayName": "",
         "ip": "192.168.0.101",
         "ipv6": "",
         "labels": {
           "node-role.kubernetes.io/master": "",
           "nvidia-device-enable": "false"
         },
         "networkDevice": "",
         "port": 22,
         "proxy": {},
         "publicIP": "",
         "role": "",
         "username": "root"
       },
       {
         "displayName": "",
         "ip": "192.168.0.102",
         "ipv6": "",
         "labels": {
           "node-role.kubernetes.io/master": "",
           "nvidia-device-enable": "false"
         },
         "networkDevice": "",
         "port": 22,
         "proxy": {},
         "publicIP": "",
         "role": "",
         "username": "root"
       },
       {
         "displayName": "",
         "ip": "192.168.0.102",
         "ipv6": "",
         "labels": {
           "node-role.kubernetes.io/master": "",
           "nvidia-device-enable": "false"
         },
         "networkDevice": "",
         "port": 22,
         "proxy": {},
         "publicIP": "",
         "role": "",
         "username": "root"
       }
     ],
     "networkDevice": "eth0",
     "properties": {
       "maxNodePodNum": 256
     },
     "publicAlternativeNames": [
       "192.168.0.101",
       "192.168.0.102",
       "192.168.0.103",
       "192.168.0.100"
     ],
     "serviceCIDR": "10.96.0.0/12",
     "tenantID": "default",
     "type": "Baremetal",
     "version": "1.19.9"
   },
   "status": {
     "addresses": [
       {
         "host": "192.168.0.101",
         "path": "",
         "port": 6443,
         "type": "Real"
       },
       {
         "host": "192.168.0.102",
         "path": "",
         "port": 6443,
         "type": "Real"
       },
       {
         "host": "192.168.0.103",
         "path": "",
         "port": 6443,
         "type": "Real"
       },
       {
         "host": "192.168.0.100",
         "path": "",
         "port": 6443,
         "type": "Advertise"
       }
     ],
     "clusterCIDR": "10.199.0.0/16",
     "conditions": [
       {
         "lastProbeTime": "2021-07-01T07:58:26Z",
         "lastTransitionTime": "2021-06-29T02:15:58Z",
         "status": "True",
         "type": "HealthCheck"
       }
     ],
     "dnsIP": "10.96.0.10",
     "nodeCIDRMaskSize": 24,
     "phase": "Running",
     "resource": {},
     "serviceCIDR": "10.96.0.0/12",
     "version": "1.19.9"
   }
 }

返回体说明

名称 类型 描述
apiVersion string 查看公共参数
kind string 查看公共参数
metadata object 查看公共参数
spec object 集群的描述。
字段路径：spec
spec.clusterCIDR string 容器网络的子网地址（CIDR 格式），例如：10.1.0.0/16，该地址应与节点子网不同。集群创建时的 Pod 可使用该网段内的 IP。
字段路径：spec.clusterCIDR
spec.clusterCredentialRef object LocalObjectReference 包含了足够多的从相同的命名空间中下载参考对象的信息。
字段路径：spec.clusterCredentialRef
clusterCredentialRef.name string 引用对象的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
字段路径：spec.clusterCredentialRef.name
spec.displayName string 集群的显示名称。
字段路径：spec.displayName
spec.dnsDomain string DNSDomain 是被 k8s Service 使用的 DNS 域名。默认为 "cluster.local"。
字段路径：spec.dnsDomain
spec.etcd object Etcd 包含了描述 Etcd 配置的元素。
字段路径：spec.etcd
etcd.local object LocalEtcd 描述了 kubeadm 应该在本地运行 etcd 集群。
字段路径：spec.etcd.local
local.dataDir string DataDir 是 etcd 存放数据的目录。默认为“/var/lib/etcd”。
字段路径：spec.etcd.local.dataDir
local.serverCertSANs array ServerCertSANs 为 etcd 服务器签名证书设置额外的域名。
字段路径：spec.etcd.local.serverCertSANs
local.serverCertSANs[] string
字段路径：spec.etcd.local.serverCertSANs[]
spec.features object ClusterFeature 记录了集群启用的特性。
字段路径：spec.features
features.enableMasterSchedule boolean 是否允许将应用调度到控制节点上。
字段路径：spec.features.enableMasterSchedule
features.files array 部署节点时额外复制的文件。
字段路径：spec.features.files
features.files[] object
字段路径：spec.features.files[]
files[].dst string 目标文件，只支持常规文件。
字段路径：spec.features.files[].dst
files[].src string 源文件，仅支持常规文件。
字段路径：spec.features.files[].src
features.ha object
字段路径：spec.features.ha
ha.thirdParty object
字段路径：spec.features.ha.thirdParty
thirdParty.vip string 第三方 HA（Highly Available） 的虚拟 IP。
字段路径：spec.features.ha.thirdParty.vip
thirdParty.vport integer (int32) 第三方 HA（Highly Available） 的虚拟端口。
字段路径：spec.features.ha.thirdParty.vport
features.ipvs boolean Ipvs 开关。
字段路径：spec.features.ipvs
features.skipConditions array SkipConditions 是一系列需要被跳过的状态。
字段路径：spec.features.skipConditions
features.skipConditions[] string
字段路径：spec.features.skipConditions[]
features.upgrade object
字段路径：spec.features.upgrade
upgrade.mode string 升级模式，默认值为 Auto。
字段路径：spec.features.upgrade.mode
upgrade.strategy object 用于控制升级过程的策略。
字段路径：spec.features.upgrade.strategy
strategy.drainNodeBeforeUpgrade boolean 升级前是否逐出节点上的 Pod。如果你的 Pod 不能接受被逐出当前节点，这个值应该是 false。
字段路径：spec.features.upgrade.strategy.drainNodeBeforeUpgrade
strategy.maxUnready string (int-or-string) IntOrString 是一种可以保存 int32 或 string 的类型。当在 JSON 或 YAML 编组和解组中使用时，它会生成或使用内部类型。例如，这允许您拥有一个可以接受名称或数字的 JSON 字段。
字段路径：spec.features.upgrade.strategy.maxUnready
spec.finalizers array 终结器是一个内部的值列表，必须为空才能从存储中永久删除对象。
字段路径：spec.finalizers
spec.finalizers[] string
字段路径：spec.finalizers[]
spec.kubeletExtraArgs object Kubelet 额外的配置参数。
字段路径：spec.kubeletExtraArgs
spec.machines array 集群节点，代表集群中的控制节点。
字段路径：spec.machines
spec.machines[] object ClusterMachine 是集群的 master 节点定义。
字段路径：spec.machines[]
machines[].displayName string 显示名称。
字段路径：spec.machines[].displayName
machines[].ip string
字段路径：spec.machines[].ip
machines[].ipv6 string IPV6 地址。
字段路径：spec.machines[].ipv6
machines[].labels object
字段路径：spec.machines[].labels
machines[].networkDevice string 网络设备（网卡）名称。
字段路径：spec.machines[].networkDevice
machines[].port integer (int32)
字段路径：spec.machines[].port
machines[].proxy object 通过 SSH 服务访问节点的代理。
字段路径：spec.machines[].proxy
machines[].publicIP string 节点的公网 IP。
字段路径：spec.machines[].publicIP
machines[].role string 节点的类型，控制节点（master）/计算节点（node）。
字段路径：spec.machines[].role
machines[].username string
字段路径：spec.machines[].username
spec.networkDevice string 网卡设备。
字段路径：spec.networkDevice
spec.properties object ClusterProperty 记录了集群的属性信息。
字段路径：spec.properties
properties.maxNodePodNum integer (int32) 节点上允许调度的最大 Pod 数。
字段路径：spec.properties.maxNodePodNum
spec.publicAlternativeNames array 签发到证书中的 APIServer 访问地址，只能填写 IP 或域名，最多 253 个字符。
字段路径：spec.publicAlternativeNames
spec.publicAlternativeNames[] string
字段路径：spec.publicAlternativeNames[]
spec.serviceCIDR string Kubernetes Service 的网络地址范围（CIDR 格式），例如：10.96.0.0/12，不可与 Cluster CIDR 的网段重叠。与 MaxClusterServiceNum 互斥。
字段路径：spec.serviceCIDR
spec.tenantID string 租户 ID。
字段路径：spec.tenantID
spec.type string 集群类型，自建或接入。
字段路径：spec.type
spec.version string 集群的版本。
字段路径：spec.version
status object ClusterStatus 代表集群状态的信息。
字段路径：status
status.addresses array 可到达集群的地址列表。
字段路径：status.addresses
status.addresses[] object ClusterAddress 包含了集群地址的信息。
字段路径：status.addresses[]
addresses[].host string 集群地址。
字段路径：status.addresses[].host
addresses[].path string 集群地址的 IP 地址或域名。
字段路径：status.addresses[].path
addresses[].port integer (int32) 集群地址端口号。
字段路径：status.addresses[].port
addresses[].type string 集群地址的类型，包括 Public、ExternalIP、InternalIP。
字段路径：status.addresses[].type
status.clusterCIDR string ClusterCIDR 是容器网络的子网地址（CIDR 格式），例如：10.1.0.0/16，该地址应与节点子网不同。集群创建时的 Pod 可使用该网段内的 IP。
字段路径：status.clusterCIDR
status.conditions array 集群的执行进度。
字段路径：status.conditions
status.conditions[] object ClusterCondition 包括该集群当前条件的详细信息。
字段路径：status.conditions[]
conditions[].lastProbeTime string (date-time) Time 是时间的包装。Time 支持正确的封送到 YAML 和 JSON。时间包提供方的许多工厂方法都提供了包装器。
字段路径：status.conditions[].lastProbeTime
conditions[].lastTransitionTime string (date-time) Time 是时间的包装。Time 支持正确的封送到 YAML 和 JSON。时间包提供方的许多工厂方法都提供了包装器。
字段路径：status.conditions[].lastTransitionTime
conditions[].status string 条件的状态，可以是 True、False、Unknown。
字段路径：status.conditions[].status
conditions[].type string 条件的类型。
字段路径：status.conditions[].type
status.dnsIP string 域名的 IP。
字段路径：status.dnsIP
status.nodeCIDRMaskSize integer (int32) 节点的 CIDR 掩码大小。
字段路径：status.nodeCIDRMaskSize
status.phase string 集群的执行进度阶段。
字段路径：status.phase
status.resource object ClusterResource 记录了集群的当前可用的最大资源配额信息。
字段路径：status.resource
status.serviceCIDR string Kubernetes Service 的网络地址范围（CIDR 格式），例如：10.96.0.0/12，不可与 Cluster CIDR 的网段重叠。与 MaxClusterServiceNum 互斥。
字段路径：status.serviceCIDR
status.version string 集群版本。
字段路径：status.version

其他状态码

状态码: 401

Unauthorized