1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
获取弹性容器集群的接入认证信息
默认接口请求频率限制:50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEKSClusterCredential。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群Id 示例值:cls-7ph3twqe |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Addresses | Array of IPAddress | 集群的接入地址信息 |
Credential | ClusterCredential | 集群的认证信息(token只有请求是主账号才返回,子账户请使用返回的kubeconfig) |
PublicLB | ClusterPublicLB | 集群的公网访问信息 |
InternalLB | ClusterInternalLB | 集群的内网访问信息 |
ProxyLB | Boolean | 标记是否新的内外网功能 示例值:false |
Kubeconfig | String | 连接用户集群k8s 的Config 示例值:"" |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取弹性容器集群的接入认证信息
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEKSClusterCredential
<公共请求参数>
{
"ClusterId": "cls-7ph3twqe"
}
输出示例
{
"Response": {
"Credential": {
"CACert": "",
"Token": ""
},
"Addresses": [
{
"Ip": "127.0.0.1",
"Type": "Public",
"Port": 443
}
],
"ProxyLB": true,
"RequestId": "0d1f4439-266b-4ea1-8c97-b0cca5eed7io",
"PublicLB": {
"SecurityPolicies": [
"192.168.1.1"
],
"Enabled": true,
"SecurityGroup": "",
"AllowFromCidrs": [
""
],
"ExtraParam": ""
},
"InternalLB": {
"SubnetId": "",
"Enabled": true
},
"Kubeconfig": "apiVersion: v1 \n clusters: \n - cluster: \n insecure-skip-tls-verify: true\n server: https://9.3.224.18:10909 \n name: cls-7ph3twqe \n contexts: \n - context:\n cluster: cls-7ph3twqe \n user: admin\n name: master\n current-context: master \n kind: Config \n preferences: {} \n users: \n- \n ame: admin \n user:\n token: wqwwqlWn8DaQQneFkPWht1Suorktrwewq\n"
}
}
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 | 操作不支持。 |