CdwchClient (tencentcloud-sdk-java 3.1.1010 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.cdwch.v20200915.CdwchClient

public class CdwchClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActionAlterCkUserResponse`	`ActionAlterCkUser(ActionAlterCkUserRequest req)` 新增和修改用户接口
`CreateBackUpScheduleResponse`	`CreateBackUpSchedule(CreateBackUpScheduleRequest req)` 创建或者修改备份策略
`CreateInstanceNewResponse`	`CreateInstanceNew(CreateInstanceNewRequest req)` 创建集群
`DeleteBackUpDataResponse`	`DeleteBackUpData(DeleteBackUpDataRequest req)` 删除备份数据
`DescribeBackUpJobResponse`	`DescribeBackUpJob(DescribeBackUpJobRequest req)` 查询备份任务列表
`DescribeBackUpJobDetailResponse`	`DescribeBackUpJobDetail(DescribeBackUpJobDetailRequest req)` 查询备份任务详情
`DescribeBackUpScheduleResponse`	`DescribeBackUpSchedule(DescribeBackUpScheduleRequest req)` 查询备份策略信息
`DescribeBackUpTablesResponse`	`DescribeBackUpTables(DescribeBackUpTablesRequest req)` 获取可备份表信息
`DescribeCkSqlApisResponse`	`DescribeCkSqlApis(DescribeCkSqlApisRequest req)` 查询集群用户、集群表，数据库等相关信息
`DescribeClusterConfigsResponse`	`DescribeClusterConfigs(DescribeClusterConfigsRequest req)` 获取集群的最新的几个配置文件（config.xml、metrika.xml、user.xml）的内容，显示给用户
`DescribeInstanceResponse`	`DescribeInstance(DescribeInstanceRequest req)` 根据实例ID查询某个实例的具体信息
`DescribeInstanceClustersResponse`	`DescribeInstanceClusters(DescribeInstanceClustersRequest req)` 集群vcluster列表
`DescribeInstanceKeyValConfigsResponse`	`DescribeInstanceKeyValConfigs(DescribeInstanceKeyValConfigsRequest req)` 在集群详情页面获取所有参数列表
`DescribeInstanceNodesResponse`	`DescribeInstanceNodes(DescribeInstanceNodesRequest req)` 获取实例节点信息列表
`DescribeInstanceShardsResponse`	`DescribeInstanceShards(DescribeInstanceShardsRequest req)` 获取实例shard信息列表
`DescribeInstancesNewResponse`	`DescribeInstancesNew(DescribeInstancesNewRequest req)` 获取实例列表，供外部sdk使用
`DescribeInstanceStateResponse`	`DescribeInstanceState(DescribeInstanceStateRequest req)` 集群详情页中显示集群状态、流程进度等
`DescribeSpecResponse`	`DescribeSpec(DescribeSpecRequest req)` 购买页拉取集群的数据节点和zookeeper节点的规格列表
`DestroyInstanceResponse`	`DestroyInstance(DestroyInstanceRequest req)` 销毁集群 open api
`ModifyClusterConfigsResponse`	`ModifyClusterConfigs(ModifyClusterConfigsRequest req)` 在集群配置页面修改集群配置文件接口，xml模式
`ModifyInstanceKeyValConfigsResponse`	`ModifyInstanceKeyValConfigs(ModifyInstanceKeyValConfigsRequest req)` KV模式修改配置接口
`ModifyUserNewPrivilegeResponse`	`ModifyUserNewPrivilege(ModifyUserNewPrivilegeRequest req)` 针对集群账号的权限做管控（新版）
`OpenBackUpResponse`	`OpenBackUp(OpenBackUpRequest req)` 开启或者关闭策略
`RecoverBackUpJobResponse`	`RecoverBackUpJob(RecoverBackUpJobRequest req)` 备份恢复
`ResizeDiskResponse`	`ResizeDisk(ResizeDiskRequest req)` 扩容磁盘，包含扩容数据节点，zk节点
`ScaleOutInstanceResponse`	`ScaleOutInstance(ScaleOutInstanceRequest req)` 调整clickhouse节点数量
`ScaleUpInstanceResponse`	`ScaleUpInstance(ScaleUpInstanceRequest req)` 垂直扩缩容节点规格，修改节点cvm的规格cpu，内存。规格变化阶段，服务不可用。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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

Constructor Detail

CdwchClient

public CdwchClient(Credential credential,
                   String region)

CdwchClient

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

Method Detail

ActionAlterCkUser

public ActionAlterCkUserResponse ActionAlterCkUser(ActionAlterCkUserRequest req)
                                            throws TencentCloudSDKException

新增和修改用户接口

Parameters:: req - ActionAlterCkUserRequest
Returns:: ActionAlterCkUserResponse
Throws:: TencentCloudSDKException

CreateBackUpSchedule

public CreateBackUpScheduleResponse CreateBackUpSchedule(CreateBackUpScheduleRequest req)
                                                  throws TencentCloudSDKException

创建或者修改备份策略

Parameters:: req - CreateBackUpScheduleRequest
Returns:: CreateBackUpScheduleResponse
Throws:: TencentCloudSDKException

CreateInstanceNew

public CreateInstanceNewResponse CreateInstanceNew(CreateInstanceNewRequest req)
                                            throws TencentCloudSDKException

创建集群

Parameters:: req - CreateInstanceNewRequest
Returns:: CreateInstanceNewResponse
Throws:: TencentCloudSDKException

DeleteBackUpData

public DeleteBackUpDataResponse DeleteBackUpData(DeleteBackUpDataRequest req)
                                          throws TencentCloudSDKException

删除备份数据

Parameters:: req - DeleteBackUpDataRequest
Returns:: DeleteBackUpDataResponse
Throws:: TencentCloudSDKException

DescribeBackUpJob

public DescribeBackUpJobResponse DescribeBackUpJob(DescribeBackUpJobRequest req)
                                            throws TencentCloudSDKException

查询备份任务列表

Parameters:: req - DescribeBackUpJobRequest
Returns:: DescribeBackUpJobResponse
Throws:: TencentCloudSDKException

DescribeBackUpJobDetail

public DescribeBackUpJobDetailResponse DescribeBackUpJobDetail(DescribeBackUpJobDetailRequest req)
                                                        throws TencentCloudSDKException

查询备份任务详情

Parameters:: req - DescribeBackUpJobDetailRequest
Returns:: DescribeBackUpJobDetailResponse
Throws:: TencentCloudSDKException

DescribeBackUpSchedule

public DescribeBackUpScheduleResponse DescribeBackUpSchedule(DescribeBackUpScheduleRequest req)
                                                      throws TencentCloudSDKException

查询备份策略信息

Parameters:: req - DescribeBackUpScheduleRequest
Returns:: DescribeBackUpScheduleResponse
Throws:: TencentCloudSDKException

DescribeBackUpTables

public DescribeBackUpTablesResponse DescribeBackUpTables(DescribeBackUpTablesRequest req)
                                                  throws TencentCloudSDKException

获取可备份表信息

Parameters:: req - DescribeBackUpTablesRequest
Returns:: DescribeBackUpTablesResponse
Throws:: TencentCloudSDKException

DescribeCkSqlApis
```
public DescribeCkSqlApisResponse DescribeCkSqlApis(DescribeCkSqlApisRequest req)
                                            throws TencentCloudSDKException
```
查询集群用户、集群表，数据库等相关信息

Parameters:

req - DescribeCkSqlApisRequest

Returns:

DescribeCkSqlApisResponse

Throws:

TencentCloudSDKException

DescribeClusterConfigs
```
public DescribeClusterConfigsResponse DescribeClusterConfigs(DescribeClusterConfigsRequest req)
                                                      throws TencentCloudSDKException
```
获取集群的最新的几个配置文件（config.xml、metrika.xml、user.xml）的内容，显示给用户

Parameters:

req - DescribeClusterConfigsRequest

Returns:

DescribeClusterConfigsResponse

Throws:

TencentCloudSDKException

DescribeInstance
```
public DescribeInstanceResponse DescribeInstance(DescribeInstanceRequest req)
                                          throws TencentCloudSDKException
```
根据实例ID查询某个实例的具体信息

Parameters:

req - DescribeInstanceRequest

Returns:

DescribeInstanceResponse

Throws:

TencentCloudSDKException

DescribeInstanceClusters

public DescribeInstanceClustersResponse DescribeInstanceClusters(DescribeInstanceClustersRequest req)
                                                          throws TencentCloudSDKException

集群vcluster列表

Parameters:: req - DescribeInstanceClustersRequest
Returns:: DescribeInstanceClustersResponse
Throws:: TencentCloudSDKException

DescribeInstanceKeyValConfigs

public DescribeInstanceKeyValConfigsResponse DescribeInstanceKeyValConfigs(DescribeInstanceKeyValConfigsRequest req)
                                                                    throws TencentCloudSDKException

在集群详情页面获取所有参数列表

Parameters:: req - DescribeInstanceKeyValConfigsRequest
Returns:: DescribeInstanceKeyValConfigsResponse
Throws:: TencentCloudSDKException

DescribeInstanceNodes

public DescribeInstanceNodesResponse DescribeInstanceNodes(DescribeInstanceNodesRequest req)
                                                    throws TencentCloudSDKException

获取实例节点信息列表

Parameters:: req - DescribeInstanceNodesRequest
Returns:: DescribeInstanceNodesResponse
Throws:: TencentCloudSDKException

DescribeInstanceShards

public DescribeInstanceShardsResponse DescribeInstanceShards(DescribeInstanceShardsRequest req)
                                                      throws TencentCloudSDKException

获取实例shard信息列表

Parameters:: req - DescribeInstanceShardsRequest
Returns:: DescribeInstanceShardsResponse
Throws:: TencentCloudSDKException

DescribeInstanceState
```
public DescribeInstanceStateResponse DescribeInstanceState(DescribeInstanceStateRequest req)
                                                    throws TencentCloudSDKException
```
集群详情页中显示集群状态、流程进度等

Parameters:

req - DescribeInstanceStateRequest

Returns:

DescribeInstanceStateResponse

Throws:

TencentCloudSDKException

DescribeInstancesNew

public DescribeInstancesNewResponse DescribeInstancesNew(DescribeInstancesNewRequest req)
                                                  throws TencentCloudSDKException

获取实例列表，供外部sdk使用

Parameters:: req - DescribeInstancesNewRequest
Returns:: DescribeInstancesNewResponse
Throws:: TencentCloudSDKException

DescribeSpec
```
public DescribeSpecResponse DescribeSpec(DescribeSpecRequest req)
                                  throws TencentCloudSDKException
```
购买页拉取集群的数据节点和zookeeper节点的规格列表

Parameters:

req - DescribeSpecRequest

Returns:

DescribeSpecResponse

Throws:

TencentCloudSDKException

DestroyInstance

public DestroyInstanceResponse DestroyInstance(DestroyInstanceRequest req)
                                        throws TencentCloudSDKException

销毁集群 open api

Parameters:: req - DestroyInstanceRequest
Returns:: DestroyInstanceResponse
Throws:: TencentCloudSDKException

ModifyClusterConfigs
```
public ModifyClusterConfigsResponse ModifyClusterConfigs(ModifyClusterConfigsRequest req)
                                                  throws TencentCloudSDKException
```
在集群配置页面修改集群配置文件接口，xml模式

Parameters:

req - ModifyClusterConfigsRequest

Returns:

ModifyClusterConfigsResponse

Throws:

TencentCloudSDKException

ModifyInstanceKeyValConfigs

public ModifyInstanceKeyValConfigsResponse ModifyInstanceKeyValConfigs(ModifyInstanceKeyValConfigsRequest req)
                                                                throws TencentCloudSDKException

KV模式修改配置接口

Parameters:: req - ModifyInstanceKeyValConfigsRequest
Returns:: ModifyInstanceKeyValConfigsResponse
Throws:: TencentCloudSDKException

ModifyUserNewPrivilege

public ModifyUserNewPrivilegeResponse ModifyUserNewPrivilege(ModifyUserNewPrivilegeRequest req)
                                                      throws TencentCloudSDKException

针对集群账号的权限做管控（新版）

Parameters:: req - ModifyUserNewPrivilegeRequest
Returns:: ModifyUserNewPrivilegeResponse
Throws:: TencentCloudSDKException

OpenBackUp

public OpenBackUpResponse OpenBackUp(OpenBackUpRequest req)
                              throws TencentCloudSDKException

开启或者关闭策略

Parameters:: req - OpenBackUpRequest
Returns:: OpenBackUpResponse
Throws:: TencentCloudSDKException

RecoverBackUpJob

public RecoverBackUpJobResponse RecoverBackUpJob(RecoverBackUpJobRequest req)
                                          throws TencentCloudSDKException

备份恢复

Parameters:: req - RecoverBackUpJobRequest
Returns:: RecoverBackUpJobResponse
Throws:: TencentCloudSDKException

ResizeDisk
```
public ResizeDiskResponse ResizeDisk(ResizeDiskRequest req)
                              throws TencentCloudSDKException
```
扩容磁盘，包含扩容数据节点，zk节点

Parameters:

req - ResizeDiskRequest

Returns:

ResizeDiskResponse

Throws:

TencentCloudSDKException

ScaleOutInstance

public ScaleOutInstanceResponse ScaleOutInstance(ScaleOutInstanceRequest req)
                                          throws TencentCloudSDKException

调整clickhouse节点数量

Parameters:: req - ScaleOutInstanceRequest
Returns:: ScaleOutInstanceResponse
Throws:: TencentCloudSDKException

ScaleUpInstance
```
public ScaleUpInstanceResponse ScaleUpInstance(ScaleUpInstanceRequest req)
                                        throws TencentCloudSDKException
```
垂直扩缩容节点规格，修改节点cvm的规格cpu，内存。规格变化阶段，服务不可用。

Parameters:

req - ScaleUpInstanceRequest

Returns:

ScaleUpInstanceResponse

Throws:

TencentCloudSDKException

Class CdwchClient

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

CdwchClient

CdwchClient

Method Detail

ActionAlterCkUser

CreateBackUpSchedule

CreateInstanceNew

DeleteBackUpData

DescribeBackUpJob

DescribeBackUpJobDetail

DescribeBackUpSchedule

DescribeBackUpTables

DescribeCkSqlApis

DescribeClusterConfigs

DescribeInstance

DescribeInstanceClusters

DescribeInstanceKeyValConfigs

DescribeInstanceNodes

DescribeInstanceShards

DescribeInstanceState

DescribeInstancesNew

DescribeSpec

DestroyInstance

ModifyClusterConfigs

ModifyInstanceKeyValConfigs

ModifyUserNewPrivilege

OpenBackUp

RecoverBackUpJob

ResizeDisk

ScaleOutInstance

ScaleUpInstance