全部文档
当前文档

暂无内容

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

文档中心

查询集群列表

最近更新时间:2024-01-02 17:24:21

DescribeCluster(查询集群列表)

接口描述

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

请求方式

GET/POST

输入参数

参数

类型

是否必选

描述

ClusterId

String

集群id,如不输入,则默认查询该地域下的所有集群。

Marker

Integer

分页标识,单次调用未返回全部实例时,标记下次调用的返回值的起点,默认值是0。

MaxResults

Integer

单次调用所返回的最大实例数目,默认10, 范围(0-20]。

Search

String

模糊匹配,可匹配如下字段:
集群名称(ClusterName)。

Filter.N

Filter.N数据类型

一个或者多个过滤器,有效值:
集群master管理类型:cluster-manage-mode

返回参数

参数

类型

描述

RequestId

String

请求id

MaxResults

Integer

单次调用返回的最大数

Marker

Integer

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

TotalCount

Integer

集群数量

ClusterSet

Array of ClusterSet

集群详细信息

调用示例

查询集群列表

输入示例

http://kce.api.ksyun.com/?Action=DescribeCluster&Version=2019-08-06

返回示例

{
    "ClusterSet": [
        {
            "ClusterId": "b12d7079-1e59-4626-90eb-xxxxxx",
            "ClusterName": "openapi开机集群",
            "ClusterType": "VirtualMachine",
            "ClusterManageMode": "DedicatedCluster",
            "K8sVersion": "v1.12.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,
            "CreateTime": "2019-09-10T10:56:13+08:00",
            "UpdateTime": "2019-09-10T11:02:46+08:00",
            "EnableKMSE": false,
            "NetworkType": "Flannel"
        },
        {
            "ClusterId": "c4d64fa0-0ee2-409a-b003-xxxxxx",
            "ClusterName": "k8s-1.12.3",
            "ClusterType": "VirtualMachine",
            "ClusterManageMode": "DedicatedCluster",
            "K8sVersion": "v1.12.3",
            "ClusterDesc": "",
            "PodCidr": "10.11.0.0/16",
            "ServiceCidr": "10.254.0.0/16",
            "VpcId": "31e21dca-c92e-4b06-a8ce-xxxxxx",
            "VpcCidr": "10.0.0.0/16",
            "Status": "running",
            "NodeNum": 3,
            "CreateTime": "2019-03-18T18:59:39+08:00",
            "UpdateTime": "2019-04-24T20:36:19+08:00",
            "EnableKMSE": false,
            "NetworkType": "Canal"
        }
    ],
    "RequestId": "5c4e0a37-e3c6-49e1-a67d-e9775cd592e8",
    "TotalCount": 2,
    "MaxResults": 10,
    "Marker": 0
}

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈