全部文档
当前文档

暂无内容

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

文档中心

查询集群

接口说明

本接口适用于查询集群列表及集群详细信息。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:DescribeClusters。
Version String
公共参数,本接口取值:2023-01-01。
ClusterIds String[]

集群ID

示例值:dc5718e4-1b54-43bf-ab7c-8d1ef9f43f8c
MaxResults Int

值范围0-50
默认值:10

示例值:10
默认值:10
Marker Int

分页参数
游标起始位置,每次查询返回

示例值:0
默认值:0

返回参数

参数名称
类型
描述
RequestId String
示例值:fe6ca381-bc6a-d1a3-8edc-ee89654c8ddd
Data Object
MaxResults Int
示例值:15
TotalCount Int
示例值:6
ClusterSet Object[]
ClusterId String
示例值:5539cb0b-0a1a-11f0-8e51-0a139778883d
ClusterName String
示例值:test
ClusterManageMode String
示例值:INDEPENDENT_CLUSTER
ProjectId String
示例值:0
KubernetesVersion String
示例值:v1.28.7
Network Object
NetworkPluginType String
示例值:calico
ApiServer Object
PublicApiServerEnable Boolean
EipId String

开启公网访问下必填,公网需要绑定的弹性IP id

ReserveSubnetId String

所选vpc的所在的终端子网Id

VpcCNI Object
Enable Boolean
DaemonMode String

网络模式:
• eniOnly 独占网卡
• eniMultiIP 共享网卡

SubnetIds String[]

vpc的子网id,必须选跟集群同vpc下的子网Id,可以填多个

SecurityGroup String

弹性网卡安全组id,需要跟集群同vpc下的安全组id

PodCidr String
示例值:10.67.0.0/16
ServiceCidr String
示例值:10.254.0.0/16
MaxPodPerNode Int
示例值:256
Addons Object[]
Name String
示例值:calico
ManagedClusterSpec Object
Status Object
Phase String
示例值:Installed

请求示例

curl -X GET|POST
'http://kce2.api.ksyun.com/?Action=DescribeClusters&Version=2023-01-01'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/json'
-H 'host: kce2.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d '{"ClusterIds":["xxx"],"MaxResults":"10","Marker":"0"}'

返回示例

JSON格式

{
"RequestId":"fe6ca381-bc6a-d1a3-8edc-ee89654c8ddd",
"Data":{
"MaxResults":15,
"TotalCount":6,
"ClusterSet":[
{
"ClusterId":"5539cb0b-0a1a-11f0-8e51-0a139778883d",
"ClusterName":"test",
"ClusterManageMode":"INDEPENDENT_CLUSTER",
"ProjectId":"0",
"KubernetesVersion":"v1.28.7",
"Network":{
"NetworkPluginType":"calico",
"ApiServer":{
"PublicApiServerEnable":false
},
"VpcCNI":{
"Enable":false
},
"PodCidr":"10.67.0.0/16",
"ServiceCidr":"10.254.0.0/16",
"MaxPodPerNode":256
},
"Addons":[
{
"Name":"calico"
},
{
"Name":"lb-controller"
},
{
"Name":"kube-proxy"
},
{
"Name":"lb-controller"
},
{
"Name":"ip-masq-agent"
},
{
"Name":"kubernetes-dashboard"
}
],
"ManagedClusterSpec":{
},
"Status":{
"Phase":"Installed"
}
},
{
"ClusterId":"1140a852-09f3-11f0-8e51-0a139778883d",
"ClusterName":"epc-create-test2-9",
"ClusterManageMode":"INDEPENDENT_CLUSTER",
"ProjectId":"0",
"KubernetesVersion":"v1.28.7",
"Network":{
"NetworkPluginType":"calico",
"ApiServer":{
"PublicApiServerEnable":false
},
"VpcCNI":{
"Enable":false
},
"PodCidr":"10.139.0.0/16",
"ServiceCidr":"10.229.0.0/16",
"MaxPodPerNode":256
},
"Addons":[
{
"Name":"lb-controller"
},
{
"Name":"kube-proxy"
},
{
"Name":"calico"
},
{
"Name":"ip-masq-agent"
},
{
"Name":"kubernetes-dashboard"
}
],
"ManagedClusterSpec":{
},
"Status":{
"Phase":"DeleteTimeout"
}
},
{
"ClusterId":"620cf2ad-0990-11f0-8e51-0a139778883d",
"ClusterName":"epc-create-test2-6",
"ClusterManageMode":"INDEPENDENT_CLUSTER",
"ProjectId":"0",
"KubernetesVersion":"v1.28.7",
"Network":{
"NetworkPluginType":"calico",
"ApiServer":{
"PublicApiServerEnable":false
},
"VpcCNI":{
"Enable":false
},
"PodCidr":"10.136.0.0/16",
"ServiceCidr":"10.226.0.0/16",
"MaxPodPerNode":256
},
"Addons":[
{
"Name":"lb-controller"
},
{
"Name":"kube-proxy"
},
{
"Name":"calico"
},
{
"Name":"ip-masq-agent"
},
{
"Name":"kubernetes-dashboard"
}
],
"ManagedClusterSpec":{
},
"Status":{
"Phase":"InstallFailed"
}
},
{
"ClusterId":"780f9092-e915-11ef-8959-5a0ede51b2df",
"ClusterName":"lz-openapi",
"ClusterDesc":"测试集群",
"ClusterManageMode":"INDEPENDENT_CLUSTER",
"ProjectId":"0",
"KubernetesVersion":"v1.26.11",
"Network":{
"NetworkPluginType":"calico",
"ApiServer":{
"PublicApiServerEnable":true,
"EipId":"7687fa58-8449-4e14-8270-61e771697b05",
"ReserveSubnetId":"c44bee6b-3103-4be0-97b4-1b9b73b2ae22"
},
"VpcCNI":{
"Enable":false
},
"PodCidr":"10.70.0.0/16",
"ServiceCidr":"10.254.0.0/16",
"MaxPodPerNode":256,
"SANs":[
"lztest0.com",
"lztest1.com",
"lztest2.com",
"lztest3.com",
"lztest4.com",
"lztest5.com",
"lztest6.com",
"lztest7.com",
"lztest8.com",
"lztest9.com"
]
},
"ManagedClusterSpec":{
},
"Status":{
"Phase":"DeleteTimeout"
}
},
{
"ClusterId":"cca1b847-cbd6-11ef-a0b5-6624e79c992b",
"ClusterName":"lz-30-6-1-20",
"ClusterManageMode":"INDEPENDENT_CLUSTER",
"ProjectId":"0",
"KubernetesVersion":"v1.30.6",
"Network":{
"NetworkPluginType":"calico",
"ApiServer":{
"PublicApiServerEnable":false
},
"VpcCNI":{
"Enable":false
},
"PodCidr":"10.80.0.0/16",
"ServiceCidr":"10.254.0.0/16",
"MaxPodPerNode":256
},
"ManagedClusterSpec":{
},
"Status":{
"Phase":"DeleteTimeout"
}
},
{
"ClusterId":"84182e36-be77-11ee-8a97-32bf1f5192d0",
"ClusterName":"ly-chaos",
"ClusterManageMode":"INDEPENDENT_CLUSTER",
"ProjectId":"0",
"KubernetesVersion":"v1.26.11",
"Network":{
"NetworkPluginType":"calico",
"ApiServer":{
"PublicApiServerEnable":false
},
"VpcCNI":{
"Enable":false
},
"PodCidr":"10.4.0.0/16",
"ServiceCidr":"10.254.0.0/16",
"MaxPodPerNode":256
},
"ManagedClusterSpec":{
},
"Status":{
"Phase":"DeleteTimeout"
}
}
]
}
}

错误码

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

纯净模式常规模式

纯净模式

点击可全屏预览文档内容