DescribeClusterDetail - 查询指定集群的信息

查询集群详细信息

接口说明

  • 单用户调用频率: 100 次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ClusterId

string

集群 ID。

eck-11111111

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

ClusterId

string

集群 ID。

eck-11111111

Name

string

集群名称。

your-cluster-name

AliUid

string

用户 ID。

1574790082031102

EnsRegionId

string

ENS 节点 ID。

cn-fuzhou-23

KubernetesVersion

string

集群版本,与 Kubernetes 社区基线版本保持一致。建议选择最新版本,若不指定,默认使用最新版本。

1.32.1.aliyunedge.1

VpcId

string

集群使用的专有网络。

n-xxxxxxxxx

VswitchIds

array

集群节点所在虚拟交换机 id。

string

集群节点所在虚拟交换机 id。

vsw-xxxxxxxxx

PodVswitchIds

array

Pod 虚拟交换机 ID。

string

Pod 虚拟交换机 ID。

vsw-xxxxxxxx

ContainerCidr

string

Pod 网络地址段。

172.20.0.0/16

ServiceCidr

string

Service 网络地址段。

172.19.0.0/20

PublicAccess

boolean

是否开启公网访问。

true

LoadBalancerId

string

APIServer 的 CLB 实例 ID。

lb-5snthcyu1x10g7tywj7iu****

ControlPlaneConfig

object

控制平面配置。

InstanceSpec

string

节点实例类型。

ens.esk.sn1.medium

ImageId

string

控制面虚拟机镜像 ID。

m-5ul335umat4e2y9ynwi84p3f9

SystemDiskCategory

string

节点系统盘类型。

cloud_efficiency

SystemDiskSize

integer

节点系统盘大小。

120

ContainerRuntime

string

运行时类型。

containerd

NodePortRange

string

节点服务端口范围

30000-32767

Size

integer

控制面节点数量。

3

JoinToken

string

集群接入鉴权 token。

xxxx.yyy

Config

any

集群 kubeconfig。

apiVersion: v1 clusters: - cluster: certificate-authority-data: x server: https://111.111.111.111:6443 name: kubernetes contexts: - context: cluster: kubernetes user: user name: eck-xxxxx current-context: eck-xxxx kind: Config preferences: {} users: - name: user user: client-certificate-data: x client-key-data: x

State

string

集群状态

  • initial:创建中。

  • failed:创建失败。

  • running:运行中。

  • deleting:释放中。

running

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ClusterId": "eck-11111111",
  "Name": "your-cluster-name",
  "AliUid": "1574790082031102",
  "EnsRegionId": "cn-fuzhou-23",
  "KubernetesVersion": "1.32.1.aliyunedge.1",
  "VpcId": "n-xxxxxxxxx",
  "VswitchIds": [
    "vsw-xxxxxxxxx"
  ],
  "PodVswitchIds": [
    "vsw-xxxxxxxx"
  ],
  "ContainerCidr": "172.20.0.0/16",
  "ServiceCidr": "172.19.0.0/20",
  "PublicAccess": true,
  "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
  "ControlPlaneConfig": {
    "InstanceSpec": "ens.esk.sn1.medium",
    "ImageId": "m-5ul335umat4e2y9ynwi84p3f9",
    "SystemDiskCategory": "cloud_efficiency",
    "SystemDiskSize": 120,
    "ContainerRuntime": "containerd",
    "NodePortRange": "30000-32767",
    "Size": 3
  },
  "JoinToken": "xxxx.yyy",
  "Config": "apiVersion: v1\nclusters:\n- cluster:\n    certificate-authority-data: x\n    server: https://111.111.111.111:6443\n  name: kubernetes\ncontexts:\n- context:\n    cluster: kubernetes\n    user: user\n  name: eck-xxxxx\ncurrent-context: eck-xxxx\nkind: Config\npreferences: {}\nusers:\n- name: user\n  user:\n    client-certificate-data: x\n    client-key-data: x",
  "State": "running"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情