com.tencentcloudapi.cynosdb.v20190107

Class CynosdbClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.cynosdb.v20190107.CynosdbClient

public class CynosdbClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
CynosdbClient(Credential credential, String region)
CynosdbClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
ActivateInstanceResponse	ActivateInstance(ActivateInstanceRequest req) This API is used to remove the isolation of an instance to make it accessible again.
AddInstancesResponse	AddInstances(AddInstancesRequest req) This API is used to add an instance in a cluster.
CreateAccountsResponse	CreateAccounts(CreateAccountsRequest req) This API is used to create an account.
DescribeAccountsResponse	DescribeAccounts(DescribeAccountsRequest req) This API is used to query database management accounts.
DescribeBackupConfigResponse	DescribeBackupConfig(DescribeBackupConfigRequest req) This API is used to get the backup configuration information of the specified cluster, including the full backup time range and backup file retention period.
DescribeBackupListResponse	DescribeBackupList(DescribeBackupListRequest req) This API is used to query the list of backup files.
DescribeClusterDetailResponse	DescribeClusterDetail(DescribeClusterDetailRequest req) This API is used to display cluster details.
DescribeClusterInstanceGrpsResponse	DescribeClusterInstanceGrps(DescribeClusterInstanceGrpsRequest req) This API is used to query instance groups.
DescribeClustersResponse	DescribeClusters(DescribeClustersRequest req) This API is used to the list of clusters.
DescribeDBSecurityGroupsResponse	DescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest req) This API is used to query the security group information of an instance.
DescribeInstanceDetailResponse	DescribeInstanceDetail(DescribeInstanceDetailRequest req) This API is used to query instance details.
DescribeInstancesResponse	DescribeInstances(DescribeInstancesRequest req) This API is used to query the list of instances.
DescribeInstanceSpecsResponse	DescribeInstanceSpecs(DescribeInstanceSpecsRequest req) This API is used to query instance specifications.
DescribeMaintainPeriodResponse	DescribeMaintainPeriod(DescribeMaintainPeriodRequest req) This API is used to query the instance maintenance window.
DescribeProjectSecurityGroupsResponse	DescribeProjectSecurityGroups(DescribeProjectSecurityGroupsRequest req) This API is used to query the security group information of a project.
DescribeResourcesByDealNameResponse	DescribeResourcesByDealName(DescribeResourcesByDealNameRequest req) This API is used to query the list of resources by billing order ID.
DescribeRollbackTimeRangeResponse	DescribeRollbackTimeRange(DescribeRollbackTimeRangeRequest req) This API is used to query the valid rollback time range for the specified cluster.
DescribeRollbackTimeValidityResponse	DescribeRollbackTimeValidity(DescribeRollbackTimeValidityRequest req) This API is used to query whether rollback is possible based on the specified time and cluster.
IsolateClusterResponse	IsolateCluster(IsolateClusterRequest req) This API is used to isolate a cluster.
IsolateInstanceResponse	IsolateInstance(IsolateInstanceRequest req) This API is used to isolate an instance.
ModifyBackupConfigResponse	ModifyBackupConfig(ModifyBackupConfigRequest req) This API is used to modify the backup configuration of the specified cluster.
ModifyClusterNameResponse	ModifyClusterName(ModifyClusterNameRequest req) This API is used to modify cluster name.
ModifyClusterParamResponse	ModifyClusterParam(ModifyClusterParamRequest req) This API is used to modify the parameters of a cluster.
ModifyDBInstanceSecurityGroupsResponse	ModifyDBInstanceSecurityGroups(ModifyDBInstanceSecurityGroupsRequest req) This API is used to modify the security groups bound to an instance.
ModifyInstanceNameResponse	ModifyInstanceName(ModifyInstanceNameRequest req) This API is used to modify instance name.
ModifyMaintainPeriodConfigResponse	ModifyMaintainPeriodConfig(ModifyMaintainPeriodConfigRequest req) This API is used to modify the maintenance time configuration.
OfflineClusterResponse	OfflineCluster(OfflineClusterRequest req) This API is used to deactivate a cluster.
OfflineInstanceResponse	OfflineInstance(OfflineInstanceRequest req) This API is used to deactivate an instance.
PauseServerlessResponse	PauseServerless(PauseServerlessRequest req) This API is used to pause a serverless cluster.
ResumeServerlessResponse	ResumeServerless(ResumeServerlessRequest req) This API is used to resume a serverless cluster.
SetRenewFlagResponse	SetRenewFlag(SetRenewFlagRequest req) This API is used to set auto-renewal for an instance.
UpgradeInstanceResponse	UpgradeInstance(UpgradeInstanceRequest req) This API is used to upgrade an instance.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CynosdbClient

public CynosdbClient(Credential credential,
                     String region)

CynosdbClient

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

Method Detail

ActivateInstance

public ActivateInstanceResponse ActivateInstance(ActivateInstanceRequest req)
                                          throws TencentCloudSDKException

This API is used to remove the isolation of an instance to make it accessible again.

Parameters:

req - ActivateInstanceRequest

Returns:

ActivateInstanceResponse

Throws:

TencentCloudSDKException

AddInstances

public AddInstancesResponse AddInstances(AddInstancesRequest req)
                                  throws TencentCloudSDKException

This API is used to add an instance in a cluster.

Parameters:

req - AddInstancesRequest

Returns:

AddInstancesResponse

Throws:

TencentCloudSDKException

CreateAccounts

public CreateAccountsResponse CreateAccounts(CreateAccountsRequest req)
                                      throws TencentCloudSDKException

This API is used to create an account.

Parameters:

req - CreateAccountsRequest

Returns:

CreateAccountsResponse

Throws:

TencentCloudSDKException

DescribeAccounts

public DescribeAccountsResponse DescribeAccounts(DescribeAccountsRequest req)
                                          throws TencentCloudSDKException

This API is used to query database management accounts.

Parameters:

req - DescribeAccountsRequest

Returns:

DescribeAccountsResponse

Throws:

TencentCloudSDKException

DescribeBackupConfig

public DescribeBackupConfigResponse DescribeBackupConfig(DescribeBackupConfigRequest req)
                                                  throws TencentCloudSDKException

This API is used to get the backup configuration information of the specified cluster, including the full backup time range and backup file retention period.

Parameters:

req - DescribeBackupConfigRequest

Returns:

DescribeBackupConfigResponse

Throws:

TencentCloudSDKException

DescribeBackupList

public DescribeBackupListResponse DescribeBackupList(DescribeBackupListRequest req)
                                              throws TencentCloudSDKException

This API is used to query the list of backup files.

Parameters:

req - DescribeBackupListRequest

Returns:

DescribeBackupListResponse

Throws:

TencentCloudSDKException

DescribeClusterDetail

public DescribeClusterDetailResponse DescribeClusterDetail(DescribeClusterDetailRequest req)
                                                    throws TencentCloudSDKException

This API is used to display cluster details.

Parameters:

req - DescribeClusterDetailRequest

Returns:

DescribeClusterDetailResponse

Throws:

TencentCloudSDKException

DescribeClusterInstanceGrps

public DescribeClusterInstanceGrpsResponse DescribeClusterInstanceGrps(DescribeClusterInstanceGrpsRequest req)
                                                                throws TencentCloudSDKException

This API is used to query instance groups.

Parameters:

req - DescribeClusterInstanceGrpsRequest

Returns:

DescribeClusterInstanceGrpsResponse

Throws:

TencentCloudSDKException

DescribeClusters

public DescribeClustersResponse DescribeClusters(DescribeClustersRequest req)
                                          throws TencentCloudSDKException

This API is used to the list of clusters.

Parameters:

req - DescribeClustersRequest

Returns:

DescribeClustersResponse

Throws:

TencentCloudSDKException

DescribeDBSecurityGroups

public DescribeDBSecurityGroupsResponse DescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest req)
                                                          throws TencentCloudSDKException

This API is used to query the security group information of an instance.

Parameters:

req - DescribeDBSecurityGroupsRequest

Returns:

DescribeDBSecurityGroupsResponse

Throws:

TencentCloudSDKException

DescribeInstanceDetail

public DescribeInstanceDetailResponse DescribeInstanceDetail(DescribeInstanceDetailRequest req)
                                                      throws TencentCloudSDKException

This API is used to query instance details.

Parameters:

req - DescribeInstanceDetailRequest

Returns:

DescribeInstanceDetailResponse

Throws:

TencentCloudSDKException

DescribeInstanceSpecs

public DescribeInstanceSpecsResponse DescribeInstanceSpecs(DescribeInstanceSpecsRequest req)
                                                    throws TencentCloudSDKException

This API is used to query instance specifications.

Parameters:

req - DescribeInstanceSpecsRequest

Returns:

DescribeInstanceSpecsResponse

Throws:

TencentCloudSDKException

DescribeInstances

public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException

This API is used to query the list of instances.

Parameters:

req - DescribeInstancesRequest

Returns:

DescribeInstancesResponse

Throws:

TencentCloudSDKException

DescribeMaintainPeriod

public DescribeMaintainPeriodResponse DescribeMaintainPeriod(DescribeMaintainPeriodRequest req)
                                                      throws TencentCloudSDKException

This API is used to query the instance maintenance window.

Parameters:

req - DescribeMaintainPeriodRequest

Returns:

DescribeMaintainPeriodResponse

Throws:

TencentCloudSDKException

DescribeProjectSecurityGroups

public DescribeProjectSecurityGroupsResponse DescribeProjectSecurityGroups(DescribeProjectSecurityGroupsRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query the security group information of a project.

Parameters:

req - DescribeProjectSecurityGroupsRequest

Returns:

DescribeProjectSecurityGroupsResponse

Throws:

TencentCloudSDKException

DescribeResourcesByDealName

public DescribeResourcesByDealNameResponse DescribeResourcesByDealName(DescribeResourcesByDealNameRequest req)
                                                                throws TencentCloudSDKException

This API is used to query the list of resources by billing order ID.

Parameters:

req - DescribeResourcesByDealNameRequest

Returns:

DescribeResourcesByDealNameResponse

Throws:

TencentCloudSDKException

DescribeRollbackTimeRange

public DescribeRollbackTimeRangeResponse DescribeRollbackTimeRange(DescribeRollbackTimeRangeRequest req)
                                                            throws TencentCloudSDKException

This API is used to query the valid rollback time range for the specified cluster.

Parameters:

req - DescribeRollbackTimeRangeRequest

Returns:

DescribeRollbackTimeRangeResponse

Throws:

TencentCloudSDKException

DescribeRollbackTimeValidity

public DescribeRollbackTimeValidityResponse DescribeRollbackTimeValidity(DescribeRollbackTimeValidityRequest req)
                                                                  throws TencentCloudSDKException

This API is used to query whether rollback is possible based on the specified time and cluster.

Parameters:

req - DescribeRollbackTimeValidityRequest

Returns:

DescribeRollbackTimeValidityResponse

Throws:

TencentCloudSDKException

IsolateCluster

public IsolateClusterResponse IsolateCluster(IsolateClusterRequest req)
                                      throws TencentCloudSDKException

This API is used to isolate a cluster.

Parameters:

req - IsolateClusterRequest

Returns:

IsolateClusterResponse

Throws:

TencentCloudSDKException

IsolateInstance

public IsolateInstanceResponse IsolateInstance(IsolateInstanceRequest req)
                                        throws TencentCloudSDKException

This API is used to isolate an instance.

Parameters:

req - IsolateInstanceRequest

Returns:

IsolateInstanceResponse

Throws:

TencentCloudSDKException

ModifyBackupConfig

public ModifyBackupConfigResponse ModifyBackupConfig(ModifyBackupConfigRequest req)
                                              throws TencentCloudSDKException

This API is used to modify the backup configuration of the specified cluster.

Parameters:

req - ModifyBackupConfigRequest

Returns:

ModifyBackupConfigResponse

Throws:

TencentCloudSDKException

ModifyClusterName

public ModifyClusterNameResponse ModifyClusterName(ModifyClusterNameRequest req)
                                            throws TencentCloudSDKException

This API is used to modify cluster name.

Parameters:

req - ModifyClusterNameRequest

Returns:

ModifyClusterNameResponse

Throws:

TencentCloudSDKException

ModifyClusterParam

public ModifyClusterParamResponse ModifyClusterParam(ModifyClusterParamRequest req)
                                              throws TencentCloudSDKException

This API is used to modify the parameters of a cluster.

Parameters:

req - ModifyClusterParamRequest

Returns:

ModifyClusterParamResponse

Throws:

TencentCloudSDKException

ModifyDBInstanceSecurityGroups

public ModifyDBInstanceSecurityGroupsResponse ModifyDBInstanceSecurityGroups(ModifyDBInstanceSecurityGroupsRequest req)
                                                                      throws TencentCloudSDKException

This API is used to modify the security groups bound to an instance.

Parameters:

req - ModifyDBInstanceSecurityGroupsRequest

Returns:

ModifyDBInstanceSecurityGroupsResponse

Throws:

TencentCloudSDKException

ModifyInstanceName

public ModifyInstanceNameResponse ModifyInstanceName(ModifyInstanceNameRequest req)
                                              throws TencentCloudSDKException

This API is used to modify instance name.

Parameters:

req - ModifyInstanceNameRequest

Returns:

ModifyInstanceNameResponse

Throws:

TencentCloudSDKException

ModifyMaintainPeriodConfig

public ModifyMaintainPeriodConfigResponse ModifyMaintainPeriodConfig(ModifyMaintainPeriodConfigRequest req)
                                                              throws TencentCloudSDKException

This API is used to modify the maintenance time configuration.

Parameters:

req - ModifyMaintainPeriodConfigRequest

Returns:

ModifyMaintainPeriodConfigResponse

Throws:

TencentCloudSDKException

OfflineCluster

public OfflineClusterResponse OfflineCluster(OfflineClusterRequest req)
                                      throws TencentCloudSDKException

This API is used to deactivate a cluster.

Parameters:

req - OfflineClusterRequest

Returns:

OfflineClusterResponse

Throws:

TencentCloudSDKException

OfflineInstance

public OfflineInstanceResponse OfflineInstance(OfflineInstanceRequest req)
                                        throws TencentCloudSDKException

This API is used to deactivate an instance.

Parameters:

req - OfflineInstanceRequest

Returns:

OfflineInstanceResponse

Throws:

TencentCloudSDKException

PauseServerless

public PauseServerlessResponse PauseServerless(PauseServerlessRequest req)
                                        throws TencentCloudSDKException

This API is used to pause a serverless cluster.

Parameters:

req - PauseServerlessRequest

Returns:

PauseServerlessResponse

Throws:

TencentCloudSDKException

ResumeServerless

public ResumeServerlessResponse ResumeServerless(ResumeServerlessRequest req)
                                          throws TencentCloudSDKException

This API is used to resume a serverless cluster.

Parameters:

req - ResumeServerlessRequest

Returns:

ResumeServerlessResponse

Throws:

TencentCloudSDKException

SetRenewFlag

public SetRenewFlagResponse SetRenewFlag(SetRenewFlagRequest req)
                                  throws TencentCloudSDKException

This API is used to set auto-renewal for an instance.

Parameters:

req - SetRenewFlagRequest

Returns:

SetRenewFlagResponse

Throws:

TencentCloudSDKException

UpgradeInstance

public UpgradeInstanceResponse UpgradeInstance(UpgradeInstanceRequest req)
                                        throws TencentCloudSDKException

This API is used to upgrade an instance.

Parameters:

req - UpgradeInstanceRequest

Returns:

UpgradeInstanceResponse

Throws:

TencentCloudSDKException