1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
查询集群访问端口状态(独立集群开启内网/外网访问，托管集群支持开启内网访问)
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusterEndpointStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群ID 示例值：cls-xxxxxxxx |
| IsExtranet | 否 | Boolean | 是否为外网访问（TRUE 外网访问 FALSE 内网访问，默认值： FALSE） 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 查询集群访问端口状态（Created 开启成功，Creating 开启中，NotFound 未开启） 注意：此字段可能返回 null，表示取不到有效值。 示例值：Created |
| ErrorMsg | String | 开启访问入口失败信息 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群访问端口状态
查询集群访问端口状态
输入示例
https://tke.tencentcloudapi.com/?Action=DescribeClusterEndpointStatus
&ClusterId=cls-7ph3twqe
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"Status": "Created",
"ErrorMsg": "error"
}
}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 | 操作失败。 |
| FailedOperation.KubeClientConnection | 连接用户Kubernetes集群失败。 |
| FailedOperation.KubernetesInternal | Kubernetes未知错误。 |
| InternalError | 内部错误。 |
| InternalError.CamNoAuth | 没有权限。 |
| InternalError.ClusterNotFound | 集群未找到。 |
| InternalError.ClusterState | 集群状态错误。 |
| InternalError.KubeClientConnection | 连接用户Kubernetes集群失败。 |
| InternalError.KubeCommon | KubernetesAPI错误。 |
| InternalError.KubernetesInternal | Kubernetes未知错误。 |
| InternalError.Param | Param。 |
| InternalError.UnexpectedInternal | 未知的内部错误。 |
| InternalError.VpcCommon | VPC报错。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Param | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
