1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
获取边缘计算集群的认证信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTKEEdgeClusterCredential。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore 。 |
ClusterId | 是 | String | 集群Id 示例值:cls-abcd1234 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Addresses | Array of IPAddress | 集群的接入地址信息 注意:此字段可能返回 null,表示取不到有效值。 |
Credential | ClusterCredential | 集群的认证信息 |
PublicLB | EdgeClusterPublicLB | 集群的公网访问信息 |
InternalLB | EdgeClusterInternalLB | 集群的内网访问信息 |
CoreDns | String | 集群的CoreDns部署信息 示例值:yes |
HealthRegion | String | 集群的健康检查多地域部署信息 示例值:yes |
Health | String | 集群的健康检查部署信息 示例值:yes |
GridDaemon | String | 是否部署GridDaemon以支持headless service 示例值:yes |
UnitCluster | String | 公网访问kins集群 示例值:yes |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取边缘计算集群的接入认证信息
获取边缘集群的认证信息,其中包含kubeconfig文件
输入示例
https://tke.tencentcloudapi.com/?Action=DescribeTKEEdgeClusterCredential
&ClusterId=cls-1234abcd
&<公共请求参数>
输出示例
{
"Response": {
"Addresses": [
{
"Type": "advertise",
"Ip": "169.254.128.200",
"Port": 60002
},
{
"Type": "public",
"Ip": "100.98.109.15",
"Port": 11126
}
],
"Credential": {
"CACert": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FULQo=",
"Token": "WBnCe69iqui0HuEZJ0Yac2hvwxQ1jG0j"
},
"CoreDns": "yes",
"HealthRegion": "yes",
"Health": "yes",
"UnitCluster": "yes",
"GridDaemon": "yes",
"PublicLB": {
"Enabled": true,
"AllowFromCidrs": [
"160/254.0.0/16"
]
},
"InternalLB": {
"SubnetId": [
"vpc-12345"
],
"Enabled": true
},
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
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 | 内部错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |