全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询集群列表(新)

接口说明

该接口可用于快速查询集群列表,相对2019-08-06版本的接口,这个接口属于轻量级API,速度与效率更高,不会返回EnhanceServiceSet、ManagedClusterControlPlaneLog等控制面信息。需要查询全量集群基本信息,请使用DescribeClusterSummary。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:DescribeCluster。
Version String
公共参数,本接口取值:2023-11-15。
ClusterId String
Marker Int
默认值:0
MaxResults Int

值范围0-20

默认值:10
Search String

集群名称模糊匹配

Filter.N Object
Name String

当前只支持 cluster-manage-mode

Value String[]
  • ExternalCluster 纳管集群
  • ManagedCluster 托管集群
  • DedicatedCluster 独立部署集群
  • ServerlessCluster serverless集群

返回参数

参数名称
类型
描述
RequestId String

请求ID

示例值:5c4e0a37-e3c6-49e1-a67d-e9775cd592e8
TotalCount Int

集群总数量

示例值:5
MaxResults Int

单次调用返回的最大记录数

示例值:20
Marker Int

分页标识,如果调用未返回全部实例,标记下次调用的返回值的起点,如果已返回全部实例,则其值为0

示例值:0
ClusterSet Object[]
ClusterId String

集群ID

示例值:b12d7079-1e59-4626-90eb-xxxxxx
ClusterName String

集群名称

示例值:mycluster
ClusterType String

该字段已废弃

示例值:VirtualMachine
ClusterManageMode String

集群管理形态

  • DedicatedCluster 独立部署集群
  • ManagedCluster 托管集群
  • ServerlessCluster serverless集群
  • ExternalCluster 纳管集群
示例值:DedicatedCluster
K8sVersion String

k8s集群版本

示例值:v1.21.3
ClusterDesc String

集群描述信息

示例值:this is my k8s cluster
PodCidr String

集群pod网段

示例值:10.66.0.0/16
ServiceCidr String

集群Service网段

示例值:10.254.0.0/16
VpcId String

集群VpcId

示例值:31e21dca-c92e-4b06-a8ce-xxxxxxx
VpcCidr String

集群Vpc网段

示例值:10.0.0.0/16
Status String

集群状态

  • building 创建中
  • running 运行中
  • not ready 异常
  • error 创建失败
  • deleting 删除中
  • pending 等待接入(纳管集群)
  • imported 已接入(纳管集群)
示例值:running
NodeNum Int

Worker节点总数

示例值:5
NormalNodeNum Int

Worker正常节点数量

示例值:3
NetworkType String

集群网络模型

  • Flannel
  • Canal
  • Calico
示例值:Flannel
MaxPodPerNode Int

单个节点上运行的pod数量上限

示例值:128
MasterEtcdSeparate Boolean

集群Master与Etcd组件是否分开部署

示例值:false
OrderType Int

订单类型

  • 1 试用订单
  • 2 常规订单
  • 3 协议订单
示例值:2
ServiceEndTime String

服务结束时间,一般预付费包年包月才有该值,格式 yyyy-MM-dd HH:mm:ss

示例值:2026-08-20 20:00:00
EnableKMSE Boolean

是否已支持微服务

示例值:false
CreateTime String

集群创建时间

示例值:2024-07-01T11:29:27+08:00
UpdateTime String

更新时间

示例值:2024-07-01T11:52:54+08:00

请求示例

curl -X GET|POST
'http://kce.api.ksyun.com/?Action=DescribeCluster&Version=2023-11-15'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/x-www-form-urlencoded'
-H 'host: kce.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d 'ClusterId=xxx&Marker=0&MaxResults=10&Search=xxx&Filter.N.Name=xxx&Filter.N.Value[0]=xxx'

返回示例

JSON格式

{
"ClusterSet":[
{
"ClusterId":"b12d7079-1e59-4626-90eb-xxxxxx",
"ClusterName":"openapi开机集群",
"ClusterType":"VirtualMachine",
"ClusterManageMode":"DedicatedCluster",
"K8sVersion":"v1.21.3",
"ClusterDesc":"This is a test cluster",
"PodCidr":"10.66.0.0/16",
"ServiceCidr":"10.254.0.0/16",
"VpcId":"31e21dca-c92e-4b06-a8ce-xxxxxxx",
"VpcCidr":"10.0.0.0/16",
"Status":"running",
"NodeNum":3,
"NormalNodeNum":3,
"CreateTime":"2022-05-12T15:59:35+08:00",
"UpdateTime":"2022-05-12T16:06:34+08:00",
"EnableKMSE":false,
"NetworkType":"Flannel",
"MaxPodPerNode":128,
"MasterEtcdSeparate":false,
"EnhanceServiceSet":null,
"KciSubnetSet":null,
"KciSecurityGroupSet":null,
"ManagedClusterControlPlaneLog":null,
"OrderType":2,
"ServiceEndTime":null,
"VpcCni":null
},
{
"ClusterId":"b544eabd-90a9-426b-849b-45f800axxxxx",
"ClusterName":"test",
"ClusterType":"VirtualMachine",
"ClusterManageMode":"DedicatedCluster",
"K8sVersion":"v1.21.3",
"ClusterDesc":"test",
"PodCidr":"172.16.0.0/16",
"ServiceCidr":"10.254.0.0/16",
"VpcId":"52e9ce14-8da3-4ca8-a9de-b7ef5e63f111",
"VpcCidr":"10.0.0.0/16",
"Status":"running",
"NodeNum":1,
"NormalNodeNum":0,
"CreateTime":"2023-04-07T16:11:03+08:00",
"UpdateTime":"2023-05-23T11:00:36+08:00",
"EnableKMSE":false,
"NetworkType":"Flannel",
"MaxPodPerNode":128,
"MasterEtcdSeparate":false,
"EnhanceServiceSet":null,
"KciSubnetSet":null,
"KciSecurityGroupSet":null,
"ManagedClusterControlPlaneLog":null,
"OrderType":2,
"ServiceEndTime":null,
"VpcCni":null
}
],
"RequestId":"5c4e0a37-e3c6-49e1-a67d-e9775cd592e8",
"TotalCount":2,
"MaxResults":10,
"Marker":0
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
ClusterIdInvalidClusterId must match `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$`400集群ID必须满足 `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$`
MarkerInvalidMarker must be greater or equal to 0400Marker必须大于等于0
MaxResultsInvalidMaxResults must be equal or less than 20400MaxResults必须小于等于20
SearchInvalidthe length of Search can't exceed 100400Search长度不能超过100个字符
FilterInvalidunsupported Filter, only supports cluster-manage-mode400不支持的filter过滤,仅支持clluster-manage-mode过滤
FilterValueInvalidFilterValue contains repeat value xx400过滤参数包含重复Value值
纯净模式常规模式

纯净模式

点击可全屏预览文档内容