查询集群列表

最近更新时间:2019-04-28 15:40:22

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

查询集群列表

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusters
Version String 公共参数,本接口取值:2018-05-25
Region String 公共参数,详见产品支持的地域列表
ClusterIds.N Array of String 集群ID列表(为空时,
表示获取账号下所有集群)
Offset Integer 偏移量,默认0
Limit Integer 最大输出条数,默认20
Filters.N Array of Filter 过滤条件,当前只支持按照单个条件ClusterName进行过滤

3. 输出参数

参数名称 类型 描述
TotalCount Integer 集群总个数
Clusters Array of Cluster 集群信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群列表

查询集群列表,用于获取集群列表

输入示例

https://tke.tencentcloudapi.com/?Action=DescribeClusters
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "Clusters": [
      {
        "ClusterId": "cls-xxxxxxx",
        "ClusterName": "集群",
        "ClusterDescription": "",
        "ClusterVersion": "1.10.5",
        "ClusterOs": "ubuntu16.04.1 LTSx86_64",
        "ClusterType": "INDEPENDENT_CLUSTER",
        "ClusterNetworkSettings": {
          "ClusterCIDR": "10.211.0.0/16",
          "IgnoreClusterCIDRConflict": false,
          "MaxNodePodNum": 256,
          "MaxClusterServiceNum": 256,
          "Ipvs": false,
          "VpcId": "vpc-xxxxxx"
        },
        "ClusterNodeNum": 3
      }
    ],
    "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InternalError.Db db错误。
InternalError.DbAffectivedRows DB影响函数错误。
InternalError.Param Param。
InternalError.PublicClusterOpNotSupport 集群不支持当前操作。
InternalError.QuotaMaxClsLimit 超过配额限制。
InternalError.QuotaMaxNodLimit 超过配额限制。
InvalidParameter 参数错误
LimitExceeded 超过配额限制
ResourceNotFound 资源不存在