1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
获取集群的访问地址,包括内网地址,外网地址,外网域名,外网访问安全策略
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeClusterEndpoints。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:cls-65r1c5nu |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CertificationAuthority | String | 集群APIServer的CA证书 示例值:”“ |
ClusterExternalEndpoint | String | 集群APIServer的外网访问地址 示例值:12.34.56.78 |
ClusterIntranetEndpoint | String | 集群APIServer的内网访问地址 示例值:10.0.0.1 |
ClusterDomain | String | 集群APIServer的域名 注意:此字段可能返回 null,表示取不到有效值。 示例值:cls-65r1c5nu.ccs.tencent-cloud.com |
ClusterExternalACL | Array of String | 集群APIServer的外网访问ACL列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["10.0.0.0/24"] |
ClusterExternalDomain | String | 外网域名 注意:此字段可能返回 null,表示取不到有效值。 示例值:cls.domain |
ClusterIntranetDomain | String | 内网域名 注意:此字段可能返回 null,表示取不到有效值。 示例值:cls.domain |
SecurityGroup | String | 外网安全组 注意:此字段可能返回 null,表示取不到有效值。 示例值:sg-3euou3gv |
ClusterIntranetSubnetId | String | 内网访问所属子网 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取集群访问地址
获取集群访问地址
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterEndpoints
<公共请求参数>
{
"ClusterId": "cls-65r1c5nu"
}
输出示例
{
"Response": {
"CertificationAuthority": "",
"ClusterIntranetDomain": "cls.domain",
"ClusterExternalDomain": "cls.domain",
"SecurityGroup": "sg-2quou3re",
"ClusterExternalEndpoint": "12.34.56.78",
"ClusterIntranetEndpoint": "10.0.0.1",
"ClusterDomain": "cls-65r1c5nu.ccs.tencent-cloud.com",
"ClusterExternalACL": [
"10.0.0.0/24"
],
"ClusterIntranetSubnetId": "subnet-xxxxx",
"RequestId": "33483fde-efec-4d3c-8ff6-340d9dbc2d01"
}
}
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.ComponentClientHttp | 内部HTTP客户端错误。 |
FailedOperation.KubeCommon | KubernetesAPI错误。 |
FailedOperation.KubernetesClientBuildError | Kubernetes client建立失败。 |
InternalError | 内部错误。 |
InternalError.ComponentClientHttp | 内部HTTP客户端错误。 |
InternalError.KubeClientConnection | 连接用户Kubernetes集群失败。 |
InternalError.UnexpectedInternal | 未知的内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Param | 参数错误。 |
ResourceNotFound.ClusterNotFound | 集群不存在。 |
ResourceNotFound.KubeResourceNotFound | 用户Kubernetes集群中未找到指定资源。 |
ResourceUnavailable.ClusterInAbnormalStat | 集群状态异常。 |
UnauthorizedOperation.CamNoAuth | 无该接口CAM权限。 |