TdcpgClient (tencentcloud-sdk-java 3.1.1010 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tdcpg.v20211118.TdcpgClient

public class TdcpgClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CloneClusterToPointInTimeResponse`	`CloneClusterToPointInTime(CloneClusterToPointInTimeRequest req)` 使用指定时间点的备份克隆一个新的集群
`CreateClusterResponse`	`CreateCluster(CreateClusterRequest req)` 创建集群
`CreateClusterInstancesResponse`	`CreateClusterInstances(CreateClusterInstancesRequest req)` 在集群中新建实例
`DeleteClusterResponse`	`DeleteCluster(DeleteClusterRequest req)` 删除集群，集群中的实例和数据都将被删除，且无法恢复。只有当集群状态处于isolated(已隔离)时才生效。
`DeleteClusterInstancesResponse`	`DeleteClusterInstances(DeleteClusterInstancesRequest req)` 删除实例。只有当实例状态处于isolated(已隔离)时才生效。
`DescribeAccountsResponse`	`DescribeAccounts(DescribeAccountsRequest req)` 查询数据库账号信息
`DescribeClusterBackupsResponse`	`DescribeClusterBackups(DescribeClusterBackupsRequest req)` 查询集群的备份集
`DescribeClusterEndpointsResponse`	`DescribeClusterEndpoints(DescribeClusterEndpointsRequest req)` 查询集群接入点信息
`DescribeClusterInstancesResponse`	`DescribeClusterInstances(DescribeClusterInstancesRequest req)` 查询实例
`DescribeClusterRecoveryTimeRangeResponse`	`DescribeClusterRecoveryTimeRange(DescribeClusterRecoveryTimeRangeRequest req)` 查询集群可回档时间范围
`DescribeClustersResponse`	`DescribeClusters(DescribeClustersRequest req)` 查询集群
`DescribeResourcesByDealNameResponse`	`DescribeResourcesByDealName(DescribeResourcesByDealNameRequest req)` 根据订单号获取资源信息
`IsolateClusterResponse`	`IsolateCluster(IsolateClusterRequest req)` 隔离集群，集群的接入点网络将会断掉无法连接使用数据库。只有当集群状态处于running(运行中)时才生效。
`IsolateClusterInstancesResponse`	`IsolateClusterInstances(IsolateClusterInstancesRequest req)` 隔离实例。此接口只针对状态为running的实例生效，使用场景包括： - 批量隔离集群内所有的实例 - 在读写实例为running(运行中)时，单个/批量隔离只读实例 - 集群内所有只读实例为isolated(已隔离)时，单独隔离读写实例
`ModifyAccountDescriptionResponse`	`ModifyAccountDescription(ModifyAccountDescriptionRequest req)` 修改数据库账号描述
`ModifyClusterEndpointWanStatusResponse`	`ModifyClusterEndpointWanStatus(ModifyClusterEndpointWanStatusRequest req)` 开启或者关闭接入点外网
`ModifyClusterInstancesSpecResponse`	`ModifyClusterInstancesSpec(ModifyClusterInstancesSpecRequest req)` 修改实例规格，此接口只针对状态为running(运行中)的实例生效
`ModifyClusterNameResponse`	`ModifyClusterName(ModifyClusterNameRequest req)` 修改集群名字
`ModifyClustersAutoRenewFlagResponse`	`ModifyClustersAutoRenewFlag(ModifyClustersAutoRenewFlagRequest req)` 修改集群自动续费，只对预付费集群生效。
`RecoverClusterResponse`	`RecoverCluster(RecoverClusterRequest req)` 恢复集群，恢复集群的接入点网络，恢复后继续连接使用数据库。只有当集群状态处于isolated(已隔离)时才生效。
`RecoverClusterInstancesResponse`	`RecoverClusterInstances(RecoverClusterInstancesRequest req)` 恢复实例。此接口的使用场景包括： - 读写实例状态为running(运行中)时，批量恢复状态为isolated(已隔离)的只读实例 - 读写实例状态为isolated(已隔离)时，恢复读写实例 - 读写实例状态为isolated(已隔离)时，批量恢复读写实例以及状态为isolated(已隔离)的只读实例
`RenewClusterResponse`	`RenewCluster(RenewClusterRequest req)` 续费集群
`ResetAccountPasswordResponse`	`ResetAccountPassword(ResetAccountPasswordRequest req)` 重置数据库账号密码
`RestartClusterInstancesResponse`	`RestartClusterInstances(RestartClusterInstancesRequest req)` 重启实例，此接口只针对状态为running(运行中)的实例生效。
`TransformClusterPayModeResponse`	`TransformClusterPayMode(TransformClusterPayModeRequest req)` 转换集群付费模式，目前只支持从后付费转换成与预付费。

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
  - TdcpgClient
```
public TdcpgClient(Credential credential,
                   String region)
```
  - TdcpgClient
```
public TdcpgClient(Credential credential,
                   String region,
                   ClientProfile profile)
```
- Method Detail
  - CloneClusterToPointInTime
```
public CloneClusterToPointInTimeResponse CloneClusterToPointInTime(CloneClusterToPointInTimeRequest req)
                                                            throws TencentCloudSDKException
```
    使用指定时间点的备份克隆一个新的集群
    
    Parameters:
    
    req - CloneClusterToPointInTimeRequest
    
    Returns:
    
    CloneClusterToPointInTimeResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCluster
```
public CreateClusterResponse CreateCluster(CreateClusterRequest req)
                                    throws TencentCloudSDKException
```
    创建集群
    
    Parameters:
    
    req - CreateClusterRequest
    
    Returns:
    
    CreateClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateClusterInstances
```
public CreateClusterInstancesResponse CreateClusterInstances(CreateClusterInstancesRequest req)
                                                      throws TencentCloudSDKException
```
    在集群中新建实例
    
    Parameters:
    
    req - CreateClusterInstancesRequest
    
    Returns:
    
    CreateClusterInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteCluster
```
public DeleteClusterResponse DeleteCluster(DeleteClusterRequest req)
                                    throws TencentCloudSDKException
```
    删除集群，集群中的实例和数据都将被删除，且无法恢复。只有当集群状态处于isolated(已隔离)时才生效。
    
    Parameters:
    
    req - DeleteClusterRequest
    
    Returns:
    
    DeleteClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteClusterInstances
```
public DeleteClusterInstancesResponse DeleteClusterInstances(DeleteClusterInstancesRequest req)
                                                      throws TencentCloudSDKException
```
    删除实例。只有当实例状态处于isolated(已隔离)时才生效。
    
    Parameters:
    
    req - DeleteClusterInstancesRequest
    
    Returns:
    
    DeleteClusterInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAccounts
```
public DescribeAccountsResponse DescribeAccounts(DescribeAccountsRequest req)
                                          throws TencentCloudSDKException
```
    查询数据库账号信息
    
    Parameters:
    
    req - DescribeAccountsRequest
    
    Returns:
    
    DescribeAccountsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterBackups
```
public DescribeClusterBackupsResponse DescribeClusterBackups(DescribeClusterBackupsRequest req)
                                                      throws TencentCloudSDKException
```
    查询集群的备份集
    
    Parameters:
    
    req - DescribeClusterBackupsRequest
    
    Returns:
    
    DescribeClusterBackupsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterEndpoints
```
public DescribeClusterEndpointsResponse DescribeClusterEndpoints(DescribeClusterEndpointsRequest req)
                                                          throws TencentCloudSDKException
```
    查询集群接入点信息
    
    Parameters:
    
    req - DescribeClusterEndpointsRequest
    
    Returns:
    
    DescribeClusterEndpointsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterInstances
```
public DescribeClusterInstancesResponse DescribeClusterInstances(DescribeClusterInstancesRequest req)
                                                          throws TencentCloudSDKException
```
    查询实例
    
    Parameters:
    
    req - DescribeClusterInstancesRequest
    
    Returns:
    
    DescribeClusterInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterRecoveryTimeRange
```
public DescribeClusterRecoveryTimeRangeResponse DescribeClusterRecoveryTimeRange(DescribeClusterRecoveryTimeRangeRequest req)
                                                                          throws TencentCloudSDKException
```
    查询集群可回档时间范围
    
    Parameters:
    
    req - DescribeClusterRecoveryTimeRangeRequest
    
    Returns:
    
    DescribeClusterRecoveryTimeRangeResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusters
```
public DescribeClustersResponse DescribeClusters(DescribeClustersRequest req)
                                          throws TencentCloudSDKException
```
    查询集群
    
    Parameters:
    
    req - DescribeClustersRequest
    
    Returns:
    
    DescribeClustersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeResourcesByDealName
```
public DescribeResourcesByDealNameResponse DescribeResourcesByDealName(DescribeResourcesByDealNameRequest req)
                                                                throws TencentCloudSDKException
```
    根据订单号获取资源信息
    
    Parameters:
    
    req - DescribeResourcesByDealNameRequest
    
    Returns:
    
    DescribeResourcesByDealNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateCluster
```
public IsolateClusterResponse IsolateCluster(IsolateClusterRequest req)
                                      throws TencentCloudSDKException
```
    隔离集群，集群的接入点网络将会断掉无法连接使用数据库。只有当集群状态处于running(运行中)时才生效。
    
    Parameters:
    
    req - IsolateClusterRequest
    
    Returns:
    
    IsolateClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateClusterInstances
```
public IsolateClusterInstancesResponse IsolateClusterInstances(IsolateClusterInstancesRequest req)
                                                        throws TencentCloudSDKException
```
    隔离实例。此接口只针对状态为running的实例生效，使用场景包括： - 批量隔离集群内所有的实例 - 在读写实例为running(运行中)时，单个/批量隔离只读实例 - 集群内所有只读实例为isolated(已隔离)时，单独隔离读写实例
    
    Parameters:
    
    req - IsolateClusterInstancesRequest
    
    Returns:
    
    IsolateClusterInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyAccountDescription
```
public ModifyAccountDescriptionResponse ModifyAccountDescription(ModifyAccountDescriptionRequest req)
                                                          throws TencentCloudSDKException
```
    修改数据库账号描述
    
    Parameters:
    
    req - ModifyAccountDescriptionRequest
    
    Returns:
    
    ModifyAccountDescriptionResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyClusterEndpointWanStatus
```
public ModifyClusterEndpointWanStatusResponse ModifyClusterEndpointWanStatus(ModifyClusterEndpointWanStatusRequest req)
                                                                      throws TencentCloudSDKException
```
    开启或者关闭接入点外网
    
    Parameters:
    
    req - ModifyClusterEndpointWanStatusRequest
    
    Returns:
    
    ModifyClusterEndpointWanStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyClusterInstancesSpec
```
public ModifyClusterInstancesSpecResponse ModifyClusterInstancesSpec(ModifyClusterInstancesSpecRequest req)
                                                              throws TencentCloudSDKException
```
    修改实例规格，此接口只针对状态为running(运行中)的实例生效
    
    Parameters:
    
    req - ModifyClusterInstancesSpecRequest
    
    Returns:
    
    ModifyClusterInstancesSpecResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyClusterName
```
public ModifyClusterNameResponse ModifyClusterName(ModifyClusterNameRequest req)
                                            throws TencentCloudSDKException
```
    修改集群名字
    
    Parameters:
    
    req - ModifyClusterNameRequest
    
    Returns:
    
    ModifyClusterNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyClustersAutoRenewFlag
```
public ModifyClustersAutoRenewFlagResponse ModifyClustersAutoRenewFlag(ModifyClustersAutoRenewFlagRequest req)
                                                                throws TencentCloudSDKException
```
    修改集群自动续费，只对预付费集群生效。
    
    Parameters:
    
    req - ModifyClustersAutoRenewFlagRequest
    
    Returns:
    
    ModifyClustersAutoRenewFlagResponse
    
    Throws:
    
    TencentCloudSDKException
  - RecoverCluster
```
public RecoverClusterResponse RecoverCluster(RecoverClusterRequest req)
                                      throws TencentCloudSDKException
```
    恢复集群，恢复集群的接入点网络，恢复后继续连接使用数据库。只有当集群状态处于isolated(已隔离)时才生效。
    
    Parameters:
    
    req - RecoverClusterRequest
    
    Returns:
    
    RecoverClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - RecoverClusterInstances
```
public RecoverClusterInstancesResponse RecoverClusterInstances(RecoverClusterInstancesRequest req)
                                                        throws TencentCloudSDKException
```
    恢复实例。此接口的使用场景包括： - 读写实例状态为running(运行中)时，批量恢复状态为isolated(已隔离)的只读实例 - 读写实例状态为isolated(已隔离)时，恢复读写实例 - 读写实例状态为isolated(已隔离)时，批量恢复读写实例以及状态为isolated(已隔离)的只读实例
    
    Parameters:
    
    req - RecoverClusterInstancesRequest
    
    Returns:
    
    RecoverClusterInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RenewCluster
```
public RenewClusterResponse RenewCluster(RenewClusterRequest req)
                                  throws TencentCloudSDKException
```
    续费集群
    
    Parameters:
    
    req - RenewClusterRequest
    
    Returns:
    
    RenewClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetAccountPassword
```
public ResetAccountPasswordResponse ResetAccountPassword(ResetAccountPasswordRequest req)
                                                  throws TencentCloudSDKException
```
    重置数据库账号密码
    
    Parameters:
    
    req - ResetAccountPasswordRequest
    
    Returns:
    
    ResetAccountPasswordResponse
    
    Throws:
    
    TencentCloudSDKException
  - RestartClusterInstances
```
public RestartClusterInstancesResponse RestartClusterInstances(RestartClusterInstancesRequest req)
                                                        throws TencentCloudSDKException
```
    重启实例，此接口只针对状态为running(运行中)的实例生效。
    
    Parameters:
    
    req - RestartClusterInstancesRequest
    
    Returns:
    
    RestartClusterInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - TransformClusterPayMode
```
public TransformClusterPayModeResponse TransformClusterPayMode(TransformClusterPayModeRequest req)
                                                        throws TencentCloudSDKException
```
    转换集群付费模式，目前只支持从后付费转换成与预付费。
    
    Parameters:
    
    req - TransformClusterPayModeRequest
    
    Returns:
    
    TransformClusterPayModeResponse
    
    Throws:
    
    TencentCloudSDKException

Class TdcpgClient

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

TdcpgClient

TdcpgClient

Method Detail

CloneClusterToPointInTime

CreateCluster

CreateClusterInstances

DeleteCluster

DeleteClusterInstances

DescribeAccounts

DescribeClusterBackups

DescribeClusterEndpoints

DescribeClusterInstances

DescribeClusterRecoveryTimeRange

DescribeClusters

DescribeResourcesByDealName

IsolateCluster

IsolateClusterInstances

ModifyAccountDescription

ModifyClusterEndpointWanStatus

ModifyClusterInstancesSpec

ModifyClusterName

ModifyClustersAutoRenewFlag

RecoverCluster

RecoverClusterInstances

RenewCluster

ResetAccountPassword

RestartClusterInstances

TransformClusterPayMode