1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
查询弹性集群列表
默认接口请求频率限制：50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeEKSClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterIds.N | 否 | Array of String | 集群ID列表(为空时， 表示获取账号下所有集群) 示例值：cls-xxxxxxxx |
| Offset | 否 | Integer | 偏移量,默认0 示例值：0 |
| Limit | 否 | Integer | 最大输出条数，默认20 示例值：20 |
| Filters.N | 否 | Array of Filter | 过滤条件,当前只支持按照单个条件ClusterName进行过滤 示例值：cls-xxxxxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 集群总个数 示例值：10 |
| Clusters | Array of EksCluster | 集群信息列表 示例值：{} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群信息列表
查询集群列表，用于获取集群列表
输入示例
https://tke.tencentcloudapi.com/?Action=DescribeEKSClusters
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"Clusters": [
{
"ClusterId": "cls-xxxxxxx",
"ClusterName": "集群AA",
"K8SVersion": "1.10.5",
"VpcId": "vpc-xxxxx",
"SubnetIds": [
"subnet-xxxxx"
],
"Status": "running",
"CreatedTime": "2019-08-16T04:31:26Z"
}
],
"RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
}
}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 | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.CamNoAuth | 没有权限。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.CamNoAuth | 无该接口CAM权限。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
