1. 接口描述
此接口处于预下线状态 。
预计下线时间:2027-01-12 17:44:28
接口请求域名: tke.tencentcloudapi.com 。
This API has been retired and is no longer available. To obtain cluster access credentials (Kubeconfig), use DescribeClusterKubeconfig. To query the cluster API Server\'s access addresses, domain names, and other connection information, use DescribeClusterEndpoints. Update your integration to accommodate the replacement APIs\' request parameters and response fields. DescribeClusterKubeconfig returns credentials specific to the calling account. A cluster administrator must configure the required Kubernetes RBAC permissions for that account under \"Authorization Management\" in TKE. Select the private or public network access configuration based on your network environment. If you rely on other information returned by the retired API, submit a support ticket for assistance.
集群的密钥信息
默认接口请求频率限制:100次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeClusterSecurity。 |
| Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段 示例值:cls-7ph3twqe 取值可参考: 查询集群列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UserName | String | 集群的账号名称 示例值:"admin" |
| Password | String | 集群的访问密码 示例值:"xxiE6lEtexG8Lba7YQSoX97bPaMGNGQU" |
| CertificationAuthority | String | 集群访问CA证书 示例值:[REDACTED] |
| ClusterExternalEndpoint | String | 集群访问的地址 示例值:"https://127.0.0.1" |
| Domain | String | 集群访问的域名 示例值:"cls-7ph3twqe.ccs.tencent-cloud.com" |
| PgwEndpoint | String | 集群Endpoint地址 示例值:"0.0.0.0" |
| SecurityPolicy | Array of String | 集群访问策略组 注意:此字段可能返回 null,表示取不到有效值。 示例值:["192.168.0.1"] |
| Kubeconfig | String | 集群Kubeconfig文件 示例值:"[REDACTED]" |
| JnsGwEndpoint | String | 集群JnsGw的访问地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:"127.0.0.1:8080" |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群的密钥信息
集群的密钥信息
输入示例
https://tke.tencentcloudapi.com/?Action=DescribeClusterSecurity
&ClusterId=cls-7ph3twqe
&<公共请求参数>
输出示例
{
"Response": {
"UserName": "admin",
"Domain": "cls-7ph3twqe.ccs.tencent-cloud.com",
"CertificationAuthority": "",
"Kubeconfig": "",
"PgwEndpoint": "0.0.0.0",
"JnsGwEndpoint": "127.0.0.1:8080",
"RequestId": "5f792091-66a7-40fc-8043-4d8b9537fa44",
"SecurityPolicy": [
"192.168.0.1"
],
"ClusterExternalEndpoint": "https://127.0.0.1",
"Password": ""
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.ComponentClientHttp | 内部HTTP客户端错误。 |
| FailedOperation.ComponentClientUnpack | 内部HTTP解包失败。 |
| FailedOperation.Db | db错误。 |
| FailedOperation.DbRecordNotFound | 记录未找到。 |
| FailedOperation.DeprecatedAPI | 接口已被废弃,请使用其他接口 |
| FailedOperation.KubeCommon | KubernetesAPI错误。 |
| FailedOperation.LbCommon | 底层调用CLB未知错误。 |
| InternalError | 内部错误。 |
| InternalError.AccountUserNotAuthenticated | 账户未通过认证。 |
| InternalError.ComponentClientHttp | 内部HTTP客户端错误。 |
| InternalError.Db | db错误。 |
| InternalError.DbAffectivedRows | DB错误。 |
| InternalError.DbRecordNotFound | 记录未找到。 |
| InternalError.KubeCommon | KubernetesAPI错误。 |
| InternalError.LbCommon | 底层调用CLB未知错误。 |
| InternalError.Param | 参数错误。 |
| InternalError.UnexpectedInternal | 未知的内部错误。 |
| InvalidParameter.CidrInvalid | 参数错误,CIDR不符合规范。 |
| InvalidParameter.Param | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ClusterNotFound | 集群不存在。 |
| ResourceNotFound.KubeResourceNotFound | 用户Kubernetes集群中未找到指定资源。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.ClusterInAbnormalStat | 集群状态异常。 |
| ResourceUnavailable.ClusterState | 集群状态不支持该操作。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.CamNoAuth | 无该接口CAM权限。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |