1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
查询集群列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterIds.N | 否 | Array of String | 集群ID列表(为空时， 表示获取账号下所有集群) |
| Offset | 否 | Integer | 偏移量,默认0 |
| Limit | 否 | Integer | 最大输出条数，默认20，最大为100 |
| Filters.N | 否 | Array of Filter | · "Name":"ClusterName","Values": ["test"] 按照【集群名】进行过滤。 类型：String 必选：否 · "Name":"ClusterType","Values": ["MANAGED_CLUSTER"] 按照【集群类型】进行过滤。 类型：String 必选：否 · "Name":"ClusterStatus","Values": ["Running"] 按照【集群状态】进行过滤。 类型：String 必选：否 · "Name":"vpc-id","Values": ["vpc-123qajzs"] 按照【VPC】进行过滤。 类型：String 必选：否 · "Name":"tag-key","Values": ["testKey"] 按照【标签键】进行过滤。 类型：String 必选：否 · "Name":"tag-value","Values": ["testValue"] 按照【标签值】进行过滤。 类型：String 必选：否 · "Name":"Tags","Values": ["abc:1"] 按照【标签键值对】进行过滤。 类型：String 必选：否 |
| ClusterType | 否 | String | 集群类型，例如：MANAGED_CLUSTER 示例值：MANAGED_CLUSTER |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 集群总个数 |
| Clusters | Array of Cluster | 集群信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群列表
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<公共请求参数>
{}输出示例
{
"Response": {
"Clusters": [
{
"AutoUpgradeClusterLevel": true,
"ClusterDescription": "",
"ClusterEtcdNodeNum": 0,
"ClusterId": "cls-ayzfpv5c",
"ClusterLevel": "L5",
"ClusterMaterNodeNum": 1,
"ClusterName": "yctest",
"ClusterNetworkSettings": {
"CiliumMode": "",
"ClusterCIDR": "10.12.0.0/14",
"Cni": true,
"IgnoreClusterCIDRConflict": false,
"IgnoreServiceCIDRConflict": false,
"Ipv6ServiceCIDR": "",
"Ipvs": false,
"IsDualStack": false,
"KubeProxyMode": "",
"MaxClusterServiceNum": 1024,
"MaxNodePodNum": 64,
"ServiceCIDR": "10.15.252.0/22",
"Subnets": null,
"VpcId": "vpc-7modfjc3"
},
"ClusterNodeNum": 2,
"ClusterOs": "tlinux3.1x86_64",
"ClusterStatus": "Running",
"ClusterType": "MANAGED_CLUSTER",
"ClusterVersion": "1.24.4",
"ContainerRuntime": "containerd",
"CreatedTime": "2022-12-27T07:46:13Z",
"DeletionProtection": true,
"EnableExternalNode": false,
"ImageId": "",
"OsCustomizeType": "GENERAL",
"ProjectId": 0,
"Property": "{\"NodeNameType\":\"lan-ip\",\"NetworkType\":\"GR\"}",
"QGPUShareEnable": false,
"RuntimeVersion": "1.4.3",
"TagSpecification": null
}
],
"RequestId": "583e6c4b-ff24-42f8-87f1-37e4c00d81b7",
"TotalCount": 1
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.UnexpectedError | 不可预知的错误。 |
| InternalError | 内部错误。 |
| InternalError.CamNoAuth | 没有权限。 |
| InternalError.Db | db错误。 |
| InternalError.DbAffectivedRows | DB错误。 |
| InternalError.Param | Param。 |
| InternalError.PublicClusterOpNotSupport | 集群不支持当前操作。 |
| InternalError.QuotaMaxClsLimit | 超过配额限制。 |
| InternalError.QuotaMaxNodLimit | 超过配额限制。 |
| InternalError.UnexpectedInternal | 未知的内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Param | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.CamNoAuth | 无该接口CAM权限。 |
| UnsupportedOperation | 操作不支持。 |
