用户指南

集群的密钥信息

最近更新时间:2020-09-02 08:15:58

1. 接口描述

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

集群的密钥信息

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterSecurity。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段

3. 输出参数

参数名称 类型 描述
UserName String 集群的账号名称
Password String 集群的访问密码
CertificationAuthority String 集群访问CA证书
ClusterExternalEndpoint String 集群访问的地址
Domain String 集群访问的域名
PgwEndpoint String 集群Endpoint地址
SecurityPolicy Array of String 集群访问策略组
注意:此字段可能返回 null,表示取不到有效值。
Kubeconfig String 集群Kubeconfig文件
注意:此字段可能返回 null,表示取不到有效值。
JnsGwEndpoint String 集群JnsGw的访问地址
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 集群的密钥信息

集群的密钥信息

输入示例

https://tke.tencentcloudapi.com/?Action=DescribeClusterSecurity
&ClusterId=cls-xxxxxxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "UserName": "xxxxx",
    "CertificationAuthority": "xxxxxx",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459398"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.AccountUserNotAuthenticated 账户未通过认证。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB错误。
InternalError.DbRecordNotFound 记录未找到。
InternalError.Param Param。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter.Param 参数错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
ResourceNotFound.ClusterNotFound 集群不存在。
ResourceNotFound.KubeResourceNotFound 用户Kubernetes集群中未找到指定资源。
ResourceUnavailable 资源不可用。
ResourceUnavailable.ClusterState 集群状态不支持该操作。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.CamNoAuth 无该接口CAM权限。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
目录