TkeClient (tencentcloud-sdk-java 3.1.314 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tke.v20180525.TkeClient

public class TkeClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`TkeClient(Credential credential, String region)`
`TkeClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcquireClusterAdminRoleResponse`	`AcquireClusterAdminRole(AcquireClusterAdminRoleRequest req)` 通过此接口，可以获取集群的tke:admin的ClusterRole，即管理员角色，可以用于CAM侧高权限的用户，通过CAM策略给予子账户此接口权限，进而可以通过此接口直接获取到kubernetes集群内的管理员角色。
`AddExistedInstancesResponse`	`AddExistedInstances(AddExistedInstancesRequest req)` 添加已经存在的实例到集群
`AddNodeToNodePoolResponse`	`AddNodeToNodePool(AddNodeToNodePoolRequest req)` 将集群内节点移入节点池
`AddVpcCniSubnetsResponse`	`AddVpcCniSubnets(AddVpcCniSubnetsRequest req)` 针对VPC-CNI模式的集群，增加集群容器网络可使用的子网
`CheckInstancesUpgradeAbleResponse`	`CheckInstancesUpgradeAble(CheckInstancesUpgradeAbleRequest req)` 检查给定节点列表中哪些是可升级的
`CreateClusterResponse`	`CreateCluster(CreateClusterRequest req)` 创建集群
`CreateClusterAsGroupResponse`	`CreateClusterAsGroup(CreateClusterAsGroupRequest req)` 为已经存在的集群创建伸缩组
`CreateClusterEndpointResponse`	`CreateClusterEndpoint(CreateClusterEndpointRequest req)` 创建集群访问端口(独立集群开启内网/外网访问，托管集群支持开启内网访问)
`CreateClusterEndpointVipResponse`	`CreateClusterEndpointVip(CreateClusterEndpointVipRequest req)` 创建托管集群外网访问端口（老的方式，仅支持托管集群外网端口）
`CreateClusterInstancesResponse`	`CreateClusterInstances(CreateClusterInstancesRequest req)` 扩展(新建)集群节点
`CreateClusterNodePoolResponse`	`CreateClusterNodePool(CreateClusterNodePoolRequest req)` 创建节点池
`CreateClusterNodePoolFromExistingAsgResponse`	`CreateClusterNodePoolFromExistingAsg(CreateClusterNodePoolFromExistingAsgRequest req)` 从伸缩组创建节点池
`CreateClusterRouteResponse`	`CreateClusterRoute(CreateClusterRouteRequest req)` 创建集群路由
`CreateClusterRouteTableResponse`	`CreateClusterRouteTable(CreateClusterRouteTableRequest req)` 创建集群路由表
`CreateEKSClusterResponse`	`CreateEKSCluster(CreateEKSClusterRequest req)` 创建弹性集群
`CreatePrometheusDashboardResponse`	`CreatePrometheusDashboard(CreatePrometheusDashboardRequest req)` 创建grafana监控面板
`CreatePrometheusTemplateResponse`	`CreatePrometheusTemplate(CreatePrometheusTemplateRequest req)` 创建一个云原生Prometheus模板实例
`DeleteClusterResponse`	`DeleteCluster(DeleteClusterRequest req)` 删除集群(YUNAPI V3版本)
`DeleteClusterAsGroupsResponse`	`DeleteClusterAsGroups(DeleteClusterAsGroupsRequest req)` 删除集群伸缩组
`DeleteClusterEndpointResponse`	`DeleteClusterEndpoint(DeleteClusterEndpointRequest req)` 删除集群访问端口(独立集群开启内网/外网访问，托管集群支持开启内网访问)
`DeleteClusterEndpointVipResponse`	`DeleteClusterEndpointVip(DeleteClusterEndpointVipRequest req)` 删除托管集群外网访问端口（老的方式，仅支持托管集群外网端口）
`DeleteClusterInstancesResponse`	`DeleteClusterInstances(DeleteClusterInstancesRequest req)` 删除集群中的实例
`DeleteClusterNodePoolResponse`	`DeleteClusterNodePool(DeleteClusterNodePoolRequest req)` 删除节点池
`DeleteClusterRouteResponse`	`DeleteClusterRoute(DeleteClusterRouteRequest req)` 删除集群路由
`DeleteClusterRouteTableResponse`	`DeleteClusterRouteTable(DeleteClusterRouteTableRequest req)` 删除集群路由表
`DeleteEKSClusterResponse`	`DeleteEKSCluster(DeleteEKSClusterRequest req)` 删除弹性集群(yunapiv3)
`DeletePrometheusTemplateResponse`	`DeletePrometheusTemplate(DeletePrometheusTemplateRequest req)` 删除一个云原生Prometheus配置模板
`DeletePrometheusTemplateSyncResponse`	`DeletePrometheusTemplateSync(DeletePrometheusTemplateSyncRequest req)` 取消模板同步，这将会删除目标中该模板所生产的配置
`DescribeAvailableClusterVersionResponse`	`DescribeAvailableClusterVersion(DescribeAvailableClusterVersionRequest req)` 获取集群可以升级的所有版本
`DescribeClusterAsGroupOptionResponse`	`DescribeClusterAsGroupOption(DescribeClusterAsGroupOptionRequest req)` 集群弹性伸缩配置
`DescribeClusterAsGroupsResponse`	`DescribeClusterAsGroups(DescribeClusterAsGroupsRequest req)` 集群关联的伸缩组列表
`DescribeClusterCommonNamesResponse`	`DescribeClusterCommonNames(DescribeClusterCommonNamesRequest req)` 获取指定子账户在RBAC授权模式中对应kube-apiserver客户端证书的CommonName字段，如果没有客户端证书，将会签发一个，此接口有最大传入子账户数量上限，当前为50
`DescribeClusterControllersResponse`	`DescribeClusterControllers(DescribeClusterControllersRequest req)` 用于查询Kubernetes的各个原生控制器是否开启
`DescribeClusterEndpointStatusResponse`	`DescribeClusterEndpointStatus(DescribeClusterEndpointStatusRequest req)` 查询集群访问端口状态(独立集群开启内网/外网访问，托管集群支持开启内网访问)
`DescribeClusterEndpointVipStatusResponse`	`DescribeClusterEndpointVipStatus(DescribeClusterEndpointVipStatusRequest req)` 查询集群开启端口流程状态(仅支持托管集群外网端口)
`DescribeClusterInstancesResponse`	`DescribeClusterInstances(DescribeClusterInstancesRequest req)` 查询集群下节点实例信息
`DescribeClusterKubeconfigResponse`	`DescribeClusterKubeconfig(DescribeClusterKubeconfigRequest req)` 获取集群的kubeconfig文件，不同子账户获取自己的kubeconfig文件，该文件中有每个子账户自己的kube-apiserver的客户端证书，默认首次调此接口时候创建客户端证书，时效20年，未授予任何权限，如果是集群所有者或者主账户，则默认是cluster-admin权限。
`DescribeClusterNodePoolDetailResponse`	`DescribeClusterNodePoolDetail(DescribeClusterNodePoolDetailRequest req)` 查询节点池详情
`DescribeClusterNodePoolsResponse`	`DescribeClusterNodePools(DescribeClusterNodePoolsRequest req)` 查询节点池列表
`DescribeClusterRoutesResponse`	`DescribeClusterRoutes(DescribeClusterRoutesRequest req)` 查询集群路由
`DescribeClusterRouteTablesResponse`	`DescribeClusterRouteTables(DescribeClusterRouteTablesRequest req)` 查询集群路由表
`DescribeClustersResponse`	`DescribeClusters(DescribeClustersRequest req)` 查询集群列表
`DescribeClusterSecurityResponse`	`DescribeClusterSecurity(DescribeClusterSecurityRequest req)` 集群的密钥信息
`DescribeEKSClusterCredentialResponse`	`DescribeEKSClusterCredential(DescribeEKSClusterCredentialRequest req)` 获取弹性容器集群的接入认证信息
`DescribeEKSClustersResponse`	`DescribeEKSClusters(DescribeEKSClustersRequest req)` 查询弹性集群列表
`DescribeEnableVpcCniProgressResponse`	`DescribeEnableVpcCniProgress(DescribeEnableVpcCniProgressRequest req)` 本接口用于查询开启vpc-cni模式的任务进度
`DescribeExistedInstancesResponse`	`DescribeExistedInstances(DescribeExistedInstancesRequest req)` 查询已经存在的节点，判断是否可以加入集群
`DescribeImagesResponse`	`DescribeImages(DescribeImagesRequest req)` 获取镜像信息
`DescribePrometheusAgentInstancesResponse`	`DescribePrometheusAgentInstances(DescribePrometheusAgentInstancesRequest req)` 获取关联目标集群的实例列表
`DescribePrometheusAgentsResponse`	`DescribePrometheusAgents(DescribePrometheusAgentsRequest req)` 获取被关联集群列表
`DescribePrometheusAlertHistoryResponse`	`DescribePrometheusAlertHistory(DescribePrometheusAlertHistoryRequest req)` 获取告警历史
`DescribePrometheusAlertRuleResponse`	`DescribePrometheusAlertRule(DescribePrometheusAlertRuleRequest req)` 获取告警规则列表
`DescribePrometheusOverviewsResponse`	`DescribePrometheusOverviews(DescribePrometheusOverviewsRequest req)` 获取实例列表
`DescribePrometheusTargetsResponse`	`DescribePrometheusTargets(DescribePrometheusTargetsRequest req)` 获取targets信息
`DescribePrometheusTemplatesResponse`	`DescribePrometheusTemplates(DescribePrometheusTemplatesRequest req)` 拉取模板列表，默认模板将总是在最前面
`DescribePrometheusTemplateSyncResponse`	`DescribePrometheusTemplateSync(DescribePrometheusTemplateSyncRequest req)` 获取模板同步信息
`DescribeRegionsResponse`	`DescribeRegions(DescribeRegionsRequest req)` 获取容器服务支持的所有地域
`DescribeRouteTableConflictsResponse`	`DescribeRouteTableConflicts(DescribeRouteTableConflictsRequest req)` 查询路由表冲突列表
`EnableVpcCniNetworkTypeResponse`	`EnableVpcCniNetworkType(EnableVpcCniNetworkTypeRequest req)` GR集群可以通过本接口附加vpc-cni容器网络插件，开启vpc-cni容器网络能力
`GetUpgradeInstanceProgressResponse`	`GetUpgradeInstanceProgress(GetUpgradeInstanceProgressRequest req)` 获得节点升级当前的进度
`ModifyClusterAsGroupAttributeResponse`	`ModifyClusterAsGroupAttribute(ModifyClusterAsGroupAttributeRequest req)` 修改集群伸缩组属性
`ModifyClusterAsGroupOptionAttributeResponse`	`ModifyClusterAsGroupOptionAttribute(ModifyClusterAsGroupOptionAttributeRequest req)` 修改集群弹性伸缩属性
`ModifyClusterAttributeResponse`	`ModifyClusterAttribute(ModifyClusterAttributeRequest req)` 修改集群属性
`ModifyClusterEndpointSPResponse`	`ModifyClusterEndpointSP(ModifyClusterEndpointSPRequest req)` 修改托管集群外网端口的安全策略（老的方式，仅支持托管集群外网端口）
`ModifyClusterNodePoolResponse`	`ModifyClusterNodePool(ModifyClusterNodePoolRequest req)` 编辑节点池
`ModifyNodePoolDesiredCapacityAboutAsgResponse`	`ModifyNodePoolDesiredCapacityAboutAsg(ModifyNodePoolDesiredCapacityAboutAsgRequest req)` 修改节点池关联伸缩组的期望实例数
`ModifyPrometheusTemplateResponse`	`ModifyPrometheusTemplate(ModifyPrometheusTemplateRequest req)` 修改模板内容
`RemoveNodeFromNodePoolResponse`	`RemoveNodeFromNodePool(RemoveNodeFromNodePoolRequest req)` 移出节点池节点，但保留在集群内
`SetNodePoolNodeProtectionResponse`	`SetNodePoolNodeProtection(SetNodePoolNodeProtectionRequest req)` 仅能设置节点池中处于伸缩组的节点
`SyncPrometheusTemplateResponse`	`SyncPrometheusTemplate(SyncPrometheusTemplateRequest req)` 同步模板到实例或者集群
`UpdateClusterVersionResponse`	`UpdateClusterVersion(UpdateClusterVersionRequest req)` 升级集群 Master 组件到指定版本
`UpdateEKSClusterResponse`	`UpdateEKSCluster(UpdateEKSClusterRequest req)` 修改弹性集群名称等属性
`UpgradeClusterInstancesResponse`	`UpgradeClusterInstances(UpgradeClusterInstancesRequest req)` 给集群的一批work节点进行升级

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TkeClient

public TkeClient(Credential credential,
                 String region)

TkeClient

public TkeClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

AcquireClusterAdminRole
```
public AcquireClusterAdminRoleResponse AcquireClusterAdminRole(AcquireClusterAdminRoleRequest req)
                                                        throws TencentCloudSDKException
```
通过此接口，可以获取集群的tke:admin的ClusterRole，即管理员角色，可以用于CAM侧高权限的用户，通过CAM策略给予子账户此接口权限，进而可以通过此接口直接获取到kubernetes集群内的管理员角色。

Parameters:

req - AcquireClusterAdminRoleRequest

Returns:

AcquireClusterAdminRoleResponse

Throws:

TencentCloudSDKException

AddExistedInstances

public AddExistedInstancesResponse AddExistedInstances(AddExistedInstancesRequest req)
                                                throws TencentCloudSDKException

添加已经存在的实例到集群

Parameters:: req - AddExistedInstancesRequest
Returns:: AddExistedInstancesResponse
Throws:: TencentCloudSDKException

AddNodeToNodePool

public AddNodeToNodePoolResponse AddNodeToNodePool(AddNodeToNodePoolRequest req)
                                            throws TencentCloudSDKException

将集群内节点移入节点池

Parameters:: req - AddNodeToNodePoolRequest
Returns:: AddNodeToNodePoolResponse
Throws:: TencentCloudSDKException

AddVpcCniSubnets
```
public AddVpcCniSubnetsResponse AddVpcCniSubnets(AddVpcCniSubnetsRequest req)
                                          throws TencentCloudSDKException
```
针对VPC-CNI模式的集群，增加集群容器网络可使用的子网

Parameters:

req - AddVpcCniSubnetsRequest

Returns:

AddVpcCniSubnetsResponse

Throws:

TencentCloudSDKException

CheckInstancesUpgradeAble

public CheckInstancesUpgradeAbleResponse CheckInstancesUpgradeAble(CheckInstancesUpgradeAbleRequest req)
                                                            throws TencentCloudSDKException

检查给定节点列表中哪些是可升级的

Parameters:: req - CheckInstancesUpgradeAbleRequest
Returns:: CheckInstancesUpgradeAbleResponse
Throws:: TencentCloudSDKException

CreateCluster

public CreateClusterResponse CreateCluster(CreateClusterRequest req)
                                    throws TencentCloudSDKException

创建集群

Parameters:: req - CreateClusterRequest
Returns:: CreateClusterResponse
Throws:: TencentCloudSDKException

CreateClusterAsGroup

public CreateClusterAsGroupResponse CreateClusterAsGroup(CreateClusterAsGroupRequest req)
                                                  throws TencentCloudSDKException

为已经存在的集群创建伸缩组

Parameters:: req - CreateClusterAsGroupRequest
Returns:: CreateClusterAsGroupResponse
Throws:: TencentCloudSDKException

CreateClusterEndpoint
```
public CreateClusterEndpointResponse CreateClusterEndpoint(CreateClusterEndpointRequest req)
                                                    throws TencentCloudSDKException
```
创建集群访问端口(独立集群开启内网/外网访问，托管集群支持开启内网访问)

Parameters:

req - CreateClusterEndpointRequest

Returns:

CreateClusterEndpointResponse

Throws:

TencentCloudSDKException

CreateClusterEndpointVip
```
public CreateClusterEndpointVipResponse CreateClusterEndpointVip(CreateClusterEndpointVipRequest req)
                                                          throws TencentCloudSDKException
```
创建托管集群外网访问端口（老的方式，仅支持托管集群外网端口）

Parameters:

req - CreateClusterEndpointVipRequest

Returns:

CreateClusterEndpointVipResponse

Throws:

TencentCloudSDKException

CreateClusterInstances

public CreateClusterInstancesResponse CreateClusterInstances(CreateClusterInstancesRequest req)
                                                      throws TencentCloudSDKException

扩展(新建)集群节点

Parameters:: req - CreateClusterInstancesRequest
Returns:: CreateClusterInstancesResponse
Throws:: TencentCloudSDKException

CreateClusterNodePool

public CreateClusterNodePoolResponse CreateClusterNodePool(CreateClusterNodePoolRequest req)
                                                    throws TencentCloudSDKException

创建节点池

Parameters:: req - CreateClusterNodePoolRequest
Returns:: CreateClusterNodePoolResponse
Throws:: TencentCloudSDKException

CreateClusterNodePoolFromExistingAsg

public CreateClusterNodePoolFromExistingAsgResponse CreateClusterNodePoolFromExistingAsg(CreateClusterNodePoolFromExistingAsgRequest req)
                                                                                  throws TencentCloudSDKException

从伸缩组创建节点池

Parameters:: req - CreateClusterNodePoolFromExistingAsgRequest
Returns:: CreateClusterNodePoolFromExistingAsgResponse
Throws:: TencentCloudSDKException

CreateClusterRoute

public CreateClusterRouteResponse CreateClusterRoute(CreateClusterRouteRequest req)
                                              throws TencentCloudSDKException

创建集群路由

Parameters:: req - CreateClusterRouteRequest
Returns:: CreateClusterRouteResponse
Throws:: TencentCloudSDKException

CreateClusterRouteTable

public CreateClusterRouteTableResponse CreateClusterRouteTable(CreateClusterRouteTableRequest req)
                                                        throws TencentCloudSDKException

创建集群路由表

Parameters:: req - CreateClusterRouteTableRequest
Returns:: CreateClusterRouteTableResponse
Throws:: TencentCloudSDKException

CreateEKSCluster

public CreateEKSClusterResponse CreateEKSCluster(CreateEKSClusterRequest req)
                                          throws TencentCloudSDKException

创建弹性集群

Parameters:: req - CreateEKSClusterRequest
Returns:: CreateEKSClusterResponse
Throws:: TencentCloudSDKException

CreatePrometheusDashboard

public CreatePrometheusDashboardResponse CreatePrometheusDashboard(CreatePrometheusDashboardRequest req)
                                                            throws TencentCloudSDKException

创建grafana监控面板

Parameters:: req - CreatePrometheusDashboardRequest
Returns:: CreatePrometheusDashboardResponse
Throws:: TencentCloudSDKException

CreatePrometheusTemplate

public CreatePrometheusTemplateResponse CreatePrometheusTemplate(CreatePrometheusTemplateRequest req)
                                                          throws TencentCloudSDKException

创建一个云原生Prometheus模板实例

Parameters:: req - CreatePrometheusTemplateRequest
Returns:: CreatePrometheusTemplateResponse
Throws:: TencentCloudSDKException

DeleteCluster

public DeleteClusterResponse DeleteCluster(DeleteClusterRequest req)
                                    throws TencentCloudSDKException

删除集群(YUNAPI V3版本)

Parameters:: req - DeleteClusterRequest
Returns:: DeleteClusterResponse
Throws:: TencentCloudSDKException

DeleteClusterAsGroups

public DeleteClusterAsGroupsResponse DeleteClusterAsGroups(DeleteClusterAsGroupsRequest req)
                                                    throws TencentCloudSDKException

删除集群伸缩组

Parameters:: req - DeleteClusterAsGroupsRequest
Returns:: DeleteClusterAsGroupsResponse
Throws:: TencentCloudSDKException

DeleteClusterEndpoint
```
public DeleteClusterEndpointResponse DeleteClusterEndpoint(DeleteClusterEndpointRequest req)
                                                    throws TencentCloudSDKException
```
删除集群访问端口(独立集群开启内网/外网访问，托管集群支持开启内网访问)

Parameters:

req - DeleteClusterEndpointRequest

Returns:

DeleteClusterEndpointResponse

Throws:

TencentCloudSDKException

DeleteClusterEndpointVip
```
public DeleteClusterEndpointVipResponse DeleteClusterEndpointVip(DeleteClusterEndpointVipRequest req)
                                                          throws TencentCloudSDKException
```
删除托管集群外网访问端口（老的方式，仅支持托管集群外网端口）

Parameters:

req - DeleteClusterEndpointVipRequest

Returns:

DeleteClusterEndpointVipResponse

Throws:

TencentCloudSDKException

DeleteClusterInstances

public DeleteClusterInstancesResponse DeleteClusterInstances(DeleteClusterInstancesRequest req)
                                                      throws TencentCloudSDKException

删除集群中的实例

Parameters:: req - DeleteClusterInstancesRequest
Returns:: DeleteClusterInstancesResponse
Throws:: TencentCloudSDKException

DeleteClusterNodePool

public DeleteClusterNodePoolResponse DeleteClusterNodePool(DeleteClusterNodePoolRequest req)
                                                    throws TencentCloudSDKException

删除节点池

Parameters:: req - DeleteClusterNodePoolRequest
Returns:: DeleteClusterNodePoolResponse
Throws:: TencentCloudSDKException

DeleteClusterRoute

public DeleteClusterRouteResponse DeleteClusterRoute(DeleteClusterRouteRequest req)
                                              throws TencentCloudSDKException

删除集群路由

Parameters:: req - DeleteClusterRouteRequest
Returns:: DeleteClusterRouteResponse
Throws:: TencentCloudSDKException

DeleteClusterRouteTable

public DeleteClusterRouteTableResponse DeleteClusterRouteTable(DeleteClusterRouteTableRequest req)
                                                        throws TencentCloudSDKException

删除集群路由表

Parameters:: req - DeleteClusterRouteTableRequest
Returns:: DeleteClusterRouteTableResponse
Throws:: TencentCloudSDKException

DeleteEKSCluster

public DeleteEKSClusterResponse DeleteEKSCluster(DeleteEKSClusterRequest req)
                                          throws TencentCloudSDKException

删除弹性集群(yunapiv3)

Parameters:: req - DeleteEKSClusterRequest
Returns:: DeleteEKSClusterResponse
Throws:: TencentCloudSDKException

DeletePrometheusTemplate

public DeletePrometheusTemplateResponse DeletePrometheusTemplate(DeletePrometheusTemplateRequest req)
                                                          throws TencentCloudSDKException

删除一个云原生Prometheus配置模板

Parameters:: req - DeletePrometheusTemplateRequest
Returns:: DeletePrometheusTemplateResponse
Throws:: TencentCloudSDKException

DeletePrometheusTemplateSync
```
public DeletePrometheusTemplateSyncResponse DeletePrometheusTemplateSync(DeletePrometheusTemplateSyncRequest req)
                                                                  throws TencentCloudSDKException
```
取消模板同步，这将会删除目标中该模板所生产的配置

Parameters:

req - DeletePrometheusTemplateSyncRequest

Returns:

DeletePrometheusTemplateSyncResponse

Throws:

TencentCloudSDKException

DescribeAvailableClusterVersion

public DescribeAvailableClusterVersionResponse DescribeAvailableClusterVersion(DescribeAvailableClusterVersionRequest req)
                                                                        throws TencentCloudSDKException

获取集群可以升级的所有版本

Parameters:: req - DescribeAvailableClusterVersionRequest
Returns:: DescribeAvailableClusterVersionResponse
Throws:: TencentCloudSDKException

DescribeClusterAsGroupOption

public DescribeClusterAsGroupOptionResponse DescribeClusterAsGroupOption(DescribeClusterAsGroupOptionRequest req)
                                                                  throws TencentCloudSDKException

集群弹性伸缩配置

Parameters:: req - DescribeClusterAsGroupOptionRequest
Returns:: DescribeClusterAsGroupOptionResponse
Throws:: TencentCloudSDKException

DescribeClusterAsGroups

public DescribeClusterAsGroupsResponse DescribeClusterAsGroups(DescribeClusterAsGroupsRequest req)
                                                        throws TencentCloudSDKException

集群关联的伸缩组列表

Parameters:: req - DescribeClusterAsGroupsRequest
Returns:: DescribeClusterAsGroupsResponse
Throws:: TencentCloudSDKException

DescribeClusterCommonNames
```
public DescribeClusterCommonNamesResponse DescribeClusterCommonNames(DescribeClusterCommonNamesRequest req)
                                                              throws TencentCloudSDKException
```
获取指定子账户在RBAC授权模式中对应kube-apiserver客户端证书的CommonName字段，如果没有客户端证书，将会签发一个，此接口有最大传入子账户数量上限，当前为50

Parameters:

req - DescribeClusterCommonNamesRequest

Returns:

DescribeClusterCommonNamesResponse

Throws:

TencentCloudSDKException

DescribeClusterControllers

public DescribeClusterControllersResponse DescribeClusterControllers(DescribeClusterControllersRequest req)
                                                              throws TencentCloudSDKException

用于查询Kubernetes的各个原生控制器是否开启

Parameters:: req - DescribeClusterControllersRequest
Returns:: DescribeClusterControllersResponse
Throws:: TencentCloudSDKException

DescribeClusterEndpointStatus
```
public DescribeClusterEndpointStatusResponse DescribeClusterEndpointStatus(DescribeClusterEndpointStatusRequest req)
                                                                    throws TencentCloudSDKException
```
查询集群访问端口状态(独立集群开启内网/外网访问，托管集群支持开启内网访问)

Parameters:

req - DescribeClusterEndpointStatusRequest

Returns:

DescribeClusterEndpointStatusResponse

Throws:

TencentCloudSDKException

DescribeClusterEndpointVipStatus

public DescribeClusterEndpointVipStatusResponse DescribeClusterEndpointVipStatus(DescribeClusterEndpointVipStatusRequest req)
                                                                          throws TencentCloudSDKException

查询集群开启端口流程状态(仅支持托管集群外网端口)

Parameters:: req - DescribeClusterEndpointVipStatusRequest
Returns:: DescribeClusterEndpointVipStatusResponse
Throws:: TencentCloudSDKException

DescribeClusterInstances

public DescribeClusterInstancesResponse DescribeClusterInstances(DescribeClusterInstancesRequest req)
                                                          throws TencentCloudSDKException

查询集群下节点实例信息

Parameters:: req - DescribeClusterInstancesRequest
Returns:: DescribeClusterInstancesResponse
Throws:: TencentCloudSDKException

DescribeClusterKubeconfig
```
public DescribeClusterKubeconfigResponse DescribeClusterKubeconfig(DescribeClusterKubeconfigRequest req)
                                                            throws TencentCloudSDKException
```
获取集群的kubeconfig文件，不同子账户获取自己的kubeconfig文件，该文件中有每个子账户自己的kube-apiserver的客户端证书，默认首次调此接口时候创建客户端证书，时效20年，未授予任何权限，如果是集群所有者或者主账户，则默认是cluster-admin权限。

Parameters:

req - DescribeClusterKubeconfigRequest

Returns:

DescribeClusterKubeconfigResponse

Throws:

TencentCloudSDKException

DescribeClusterNodePoolDetail

public DescribeClusterNodePoolDetailResponse DescribeClusterNodePoolDetail(DescribeClusterNodePoolDetailRequest req)
                                                                    throws TencentCloudSDKException

查询节点池详情

Parameters:: req - DescribeClusterNodePoolDetailRequest
Returns:: DescribeClusterNodePoolDetailResponse
Throws:: TencentCloudSDKException

DescribeClusterNodePools

public DescribeClusterNodePoolsResponse DescribeClusterNodePools(DescribeClusterNodePoolsRequest req)
                                                          throws TencentCloudSDKException

查询节点池列表

Parameters:: req - DescribeClusterNodePoolsRequest
Returns:: DescribeClusterNodePoolsResponse
Throws:: TencentCloudSDKException

DescribeClusterRouteTables

public DescribeClusterRouteTablesResponse DescribeClusterRouteTables(DescribeClusterRouteTablesRequest req)
                                                              throws TencentCloudSDKException

查询集群路由表

Parameters:: req - DescribeClusterRouteTablesRequest
Returns:: DescribeClusterRouteTablesResponse
Throws:: TencentCloudSDKException

DescribeClusterRoutes

public DescribeClusterRoutesResponse DescribeClusterRoutes(DescribeClusterRoutesRequest req)
                                                    throws TencentCloudSDKException

查询集群路由

Parameters:: req - DescribeClusterRoutesRequest
Returns:: DescribeClusterRoutesResponse
Throws:: TencentCloudSDKException

DescribeClusterSecurity

public DescribeClusterSecurityResponse DescribeClusterSecurity(DescribeClusterSecurityRequest req)
                                                        throws TencentCloudSDKException

集群的密钥信息

Parameters:: req - DescribeClusterSecurityRequest
Returns:: DescribeClusterSecurityResponse
Throws:: TencentCloudSDKException

DescribeClusters

public DescribeClustersResponse DescribeClusters(DescribeClustersRequest req)
                                          throws TencentCloudSDKException

查询集群列表

Parameters:: req - DescribeClustersRequest
Returns:: DescribeClustersResponse
Throws:: TencentCloudSDKException

DescribeEKSClusterCredential

public DescribeEKSClusterCredentialResponse DescribeEKSClusterCredential(DescribeEKSClusterCredentialRequest req)
                                                                  throws TencentCloudSDKException

获取弹性容器集群的接入认证信息

Parameters:: req - DescribeEKSClusterCredentialRequest
Returns:: DescribeEKSClusterCredentialResponse
Throws:: TencentCloudSDKException

DescribeEKSClusters

public DescribeEKSClustersResponse DescribeEKSClusters(DescribeEKSClustersRequest req)
                                                throws TencentCloudSDKException

查询弹性集群列表

Parameters:: req - DescribeEKSClustersRequest
Returns:: DescribeEKSClustersResponse
Throws:: TencentCloudSDKException

DescribeEnableVpcCniProgress

public DescribeEnableVpcCniProgressResponse DescribeEnableVpcCniProgress(DescribeEnableVpcCniProgressRequest req)
                                                                  throws TencentCloudSDKException

本接口用于查询开启vpc-cni模式的任务进度

Parameters:: req - DescribeEnableVpcCniProgressRequest
Returns:: DescribeEnableVpcCniProgressResponse
Throws:: TencentCloudSDKException

DescribeExistedInstances
```
public DescribeExistedInstancesResponse DescribeExistedInstances(DescribeExistedInstancesRequest req)
                                                          throws TencentCloudSDKException
```
查询已经存在的节点，判断是否可以加入集群

Parameters:

req - DescribeExistedInstancesRequest

Returns:

DescribeExistedInstancesResponse

Throws:

TencentCloudSDKException

DescribeImages

public DescribeImagesResponse DescribeImages(DescribeImagesRequest req)
                                      throws TencentCloudSDKException

获取镜像信息

Parameters:: req - DescribeImagesRequest
Returns:: DescribeImagesResponse
Throws:: TencentCloudSDKException

DescribePrometheusAgentInstances

public DescribePrometheusAgentInstancesResponse DescribePrometheusAgentInstances(DescribePrometheusAgentInstancesRequest req)
                                                                          throws TencentCloudSDKException

获取关联目标集群的实例列表

Parameters:: req - DescribePrometheusAgentInstancesRequest
Returns:: DescribePrometheusAgentInstancesResponse
Throws:: TencentCloudSDKException

DescribePrometheusAgents

public DescribePrometheusAgentsResponse DescribePrometheusAgents(DescribePrometheusAgentsRequest req)
                                                          throws TencentCloudSDKException

获取被关联集群列表

Parameters:: req - DescribePrometheusAgentsRequest
Returns:: DescribePrometheusAgentsResponse
Throws:: TencentCloudSDKException

DescribePrometheusAlertHistory

public DescribePrometheusAlertHistoryResponse DescribePrometheusAlertHistory(DescribePrometheusAlertHistoryRequest req)
                                                                      throws TencentCloudSDKException

获取告警历史

Parameters:: req - DescribePrometheusAlertHistoryRequest
Returns:: DescribePrometheusAlertHistoryResponse
Throws:: TencentCloudSDKException

DescribePrometheusAlertRule

public DescribePrometheusAlertRuleResponse DescribePrometheusAlertRule(DescribePrometheusAlertRuleRequest req)
                                                                throws TencentCloudSDKException

获取告警规则列表

Parameters:: req - DescribePrometheusAlertRuleRequest
Returns:: DescribePrometheusAlertRuleResponse
Throws:: TencentCloudSDKException

DescribePrometheusOverviews

public DescribePrometheusOverviewsResponse DescribePrometheusOverviews(DescribePrometheusOverviewsRequest req)
                                                                throws TencentCloudSDKException

获取实例列表

Parameters:: req - DescribePrometheusOverviewsRequest
Returns:: DescribePrometheusOverviewsResponse
Throws:: TencentCloudSDKException

DescribePrometheusTargets

public DescribePrometheusTargetsResponse DescribePrometheusTargets(DescribePrometheusTargetsRequest req)
                                                            throws TencentCloudSDKException

获取targets信息

Parameters:: req - DescribePrometheusTargetsRequest
Returns:: DescribePrometheusTargetsResponse
Throws:: TencentCloudSDKException

DescribePrometheusTemplateSync

public DescribePrometheusTemplateSyncResponse DescribePrometheusTemplateSync(DescribePrometheusTemplateSyncRequest req)
                                                                      throws TencentCloudSDKException

获取模板同步信息

Parameters:: req - DescribePrometheusTemplateSyncRequest
Returns:: DescribePrometheusTemplateSyncResponse
Throws:: TencentCloudSDKException

DescribePrometheusTemplates

public DescribePrometheusTemplatesResponse DescribePrometheusTemplates(DescribePrometheusTemplatesRequest req)
                                                                throws TencentCloudSDKException

拉取模板列表，默认模板将总是在最前面

Parameters:: req - DescribePrometheusTemplatesRequest
Returns:: DescribePrometheusTemplatesResponse
Throws:: TencentCloudSDKException

DescribeRegions

public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException

获取容器服务支持的所有地域

Parameters:: req - DescribeRegionsRequest
Returns:: DescribeRegionsResponse
Throws:: TencentCloudSDKException

DescribeRouteTableConflicts

public DescribeRouteTableConflictsResponse DescribeRouteTableConflicts(DescribeRouteTableConflictsRequest req)
                                                                throws TencentCloudSDKException

查询路由表冲突列表

Parameters:: req - DescribeRouteTableConflictsRequest
Returns:: DescribeRouteTableConflictsResponse
Throws:: TencentCloudSDKException

EnableVpcCniNetworkType
```
public EnableVpcCniNetworkTypeResponse EnableVpcCniNetworkType(EnableVpcCniNetworkTypeRequest req)
                                                        throws TencentCloudSDKException
```
GR集群可以通过本接口附加vpc-cni容器网络插件，开启vpc-cni容器网络能力

Parameters:

req - EnableVpcCniNetworkTypeRequest

Returns:

EnableVpcCniNetworkTypeResponse

Throws:

TencentCloudSDKException

GetUpgradeInstanceProgress

public GetUpgradeInstanceProgressResponse GetUpgradeInstanceProgress(GetUpgradeInstanceProgressRequest req)
                                                              throws TencentCloudSDKException

获得节点升级当前的进度

Parameters:: req - GetUpgradeInstanceProgressRequest
Returns:: GetUpgradeInstanceProgressResponse
Throws:: TencentCloudSDKException

ModifyClusterAsGroupAttribute

public ModifyClusterAsGroupAttributeResponse ModifyClusterAsGroupAttribute(ModifyClusterAsGroupAttributeRequest req)
                                                                    throws TencentCloudSDKException

修改集群伸缩组属性

Parameters:: req - ModifyClusterAsGroupAttributeRequest
Returns:: ModifyClusterAsGroupAttributeResponse
Throws:: TencentCloudSDKException

ModifyClusterAsGroupOptionAttribute

public ModifyClusterAsGroupOptionAttributeResponse ModifyClusterAsGroupOptionAttribute(ModifyClusterAsGroupOptionAttributeRequest req)
                                                                                throws TencentCloudSDKException

修改集群弹性伸缩属性

Parameters:: req - ModifyClusterAsGroupOptionAttributeRequest
Returns:: ModifyClusterAsGroupOptionAttributeResponse
Throws:: TencentCloudSDKException

ModifyClusterAttribute

public ModifyClusterAttributeResponse ModifyClusterAttribute(ModifyClusterAttributeRequest req)
                                                      throws TencentCloudSDKException

修改集群属性

Parameters:: req - ModifyClusterAttributeRequest
Returns:: ModifyClusterAttributeResponse
Throws:: TencentCloudSDKException

ModifyClusterEndpointSP
```
public ModifyClusterEndpointSPResponse ModifyClusterEndpointSP(ModifyClusterEndpointSPRequest req)
                                                        throws TencentCloudSDKException
```
修改托管集群外网端口的安全策略（老的方式，仅支持托管集群外网端口）

Parameters:

req - ModifyClusterEndpointSPRequest

Returns:

ModifyClusterEndpointSPResponse

Throws:

TencentCloudSDKException

ModifyClusterNodePool

public ModifyClusterNodePoolResponse ModifyClusterNodePool(ModifyClusterNodePoolRequest req)
                                                    throws TencentCloudSDKException

编辑节点池

Parameters:: req - ModifyClusterNodePoolRequest
Returns:: ModifyClusterNodePoolResponse
Throws:: TencentCloudSDKException

ModifyNodePoolDesiredCapacityAboutAsg

public ModifyNodePoolDesiredCapacityAboutAsgResponse ModifyNodePoolDesiredCapacityAboutAsg(ModifyNodePoolDesiredCapacityAboutAsgRequest req)
                                                                                    throws TencentCloudSDKException

修改节点池关联伸缩组的期望实例数

Parameters:: req - ModifyNodePoolDesiredCapacityAboutAsgRequest
Returns:: ModifyNodePoolDesiredCapacityAboutAsgResponse
Throws:: TencentCloudSDKException

ModifyPrometheusTemplate

public ModifyPrometheusTemplateResponse ModifyPrometheusTemplate(ModifyPrometheusTemplateRequest req)
                                                          throws TencentCloudSDKException

修改模板内容

Parameters:: req - ModifyPrometheusTemplateRequest
Returns:: ModifyPrometheusTemplateResponse
Throws:: TencentCloudSDKException

RemoveNodeFromNodePool

public RemoveNodeFromNodePoolResponse RemoveNodeFromNodePool(RemoveNodeFromNodePoolRequest req)
                                                      throws TencentCloudSDKException

移出节点池节点，但保留在集群内

Parameters:: req - RemoveNodeFromNodePoolRequest
Returns:: RemoveNodeFromNodePoolResponse
Throws:: TencentCloudSDKException

SetNodePoolNodeProtection

public SetNodePoolNodeProtectionResponse SetNodePoolNodeProtection(SetNodePoolNodeProtectionRequest req)
                                                            throws TencentCloudSDKException

仅能设置节点池中处于伸缩组的节点

Parameters:: req - SetNodePoolNodeProtectionRequest
Returns:: SetNodePoolNodeProtectionResponse
Throws:: TencentCloudSDKException

SyncPrometheusTemplate

public SyncPrometheusTemplateResponse SyncPrometheusTemplate(SyncPrometheusTemplateRequest req)
                                                      throws TencentCloudSDKException

同步模板到实例或者集群

Parameters:: req - SyncPrometheusTemplateRequest
Returns:: SyncPrometheusTemplateResponse
Throws:: TencentCloudSDKException

UpdateClusterVersion

public UpdateClusterVersionResponse UpdateClusterVersion(UpdateClusterVersionRequest req)
                                                  throws TencentCloudSDKException

升级集群 Master 组件到指定版本

Parameters:: req - UpdateClusterVersionRequest
Returns:: UpdateClusterVersionResponse
Throws:: TencentCloudSDKException

UpdateEKSCluster

public UpdateEKSClusterResponse UpdateEKSCluster(UpdateEKSClusterRequest req)
                                          throws TencentCloudSDKException

修改弹性集群名称等属性

Parameters:: req - UpdateEKSClusterRequest
Returns:: UpdateEKSClusterResponse
Throws:: TencentCloudSDKException

UpgradeClusterInstances

public UpgradeClusterInstancesResponse UpgradeClusterInstances(UpgradeClusterInstancesRequest req)
                                                        throws TencentCloudSDKException

给集群的一批work节点进行升级

Parameters:: req - UpgradeClusterInstancesRequest
Returns:: UpgradeClusterInstancesResponse
Throws:: TencentCloudSDKException

Class TkeClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

TkeClient

TkeClient

Method Detail

AcquireClusterAdminRole

AddExistedInstances

AddNodeToNodePool

AddVpcCniSubnets

CheckInstancesUpgradeAble

CreateCluster

CreateClusterAsGroup

CreateClusterEndpoint

CreateClusterEndpointVip

CreateClusterInstances

CreateClusterNodePool

CreateClusterNodePoolFromExistingAsg

CreateClusterRoute

CreateClusterRouteTable

CreateEKSCluster

CreatePrometheusDashboard

CreatePrometheusTemplate

DeleteCluster

DeleteClusterAsGroups

DeleteClusterEndpoint

DeleteClusterEndpointVip

DeleteClusterInstances

DeleteClusterNodePool

DeleteClusterRoute

DeleteClusterRouteTable

DeleteEKSCluster

DeletePrometheusTemplate

DeletePrometheusTemplateSync

DescribeAvailableClusterVersion

DescribeClusterAsGroupOption

DescribeClusterAsGroups

DescribeClusterCommonNames

DescribeClusterControllers

DescribeClusterEndpointStatus

DescribeClusterEndpointVipStatus

DescribeClusterInstances

DescribeClusterKubeconfig

DescribeClusterNodePoolDetail

DescribeClusterNodePools

DescribeClusterRouteTables

DescribeClusterRoutes

DescribeClusterSecurity

DescribeClusters

DescribeEKSClusterCredential

DescribeEKSClusters

DescribeEnableVpcCniProgress

DescribeExistedInstances

DescribeImages

DescribePrometheusAgentInstances

DescribePrometheusAgents

DescribePrometheusAlertHistory

DescribePrometheusAlertRule

DescribePrometheusOverviews

DescribePrometheusTargets

DescribePrometheusTemplateSync

DescribePrometheusTemplates

DescribeRegions

DescribeRouteTableConflicts

EnableVpcCniNetworkType

GetUpgradeInstanceProgress

ModifyClusterAsGroupAttribute

ModifyClusterAsGroupOptionAttribute

ModifyClusterAttribute

ModifyClusterEndpointSP

ModifyClusterNodePool

ModifyNodePoolDesiredCapacityAboutAsg

ModifyPrometheusTemplate

RemoveNodeFromNodePool

SetNodePoolNodeProtection