TKE 标准集群指南

最佳实践

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

查看集群认证配置

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterAuthenticationOptions。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群ID

3. 输出参数

参数名称 类型 描述
ServiceAccounts ServiceAccountAuthenticationOptions ServiceAccount认证配置
注意:此字段可能返回 null,表示取不到有效值。
LatestOperationState String 最近一次修改操作结果,返回值可能为:Updating,Success,Failed,TimeOut
注意:此字段可能返回 null,表示取不到有效值。
OIDCConfig OIDCConfigAuthenticationOptions OIDC认证配置
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看集群认证配置

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterAuthenticationOptions
<公共请求参数>

{
    "ClusterId": "cls-xxxxxxxx"
}

输出示例

{
    "Response": {
        "RequestId": "xxx",
        "ServiceAccounts": {
            "JWKSURI": "https://cls-xxxxxxxx.ccs.tencent-cloud.com/openid/v1/jwks",
            "Issuer": "https://cls-xxxxxxxx.ccs.tencent-cloud.com"
        },
        "OIDCConfig": {
            "AutoCreateOIDCConfig": true,
            "AutoInstallPodIdentityWebhookAddon": true,
            "AutoCreateClientId": [
                "xx"
            ]
        },
        "LatestOperationState": "Updating"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
OperationDenied 操作被拒绝。
ResourceUnavailable.ClusterState 集群状态不支持该操作。
目录