com.tencentcloudapi.dts.v20180330

Class DtsClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.dts.v20180330.DtsClient

public class DtsClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ActivateSubscribeResponse	ActivateSubscribe(ActivateSubscribeRequest req) This API is used to configure a data subscription, which can be called only for subscription instances in unconfigured status.
CompleteMigrateJobResponse	CompleteMigrateJob(CompleteMigrateJobRequest req) This API (CompleteMigrateJob) is used to complete a data migration task.
CreateMigrateCheckJobResponse	CreateMigrateCheckJob(CreateMigrateCheckJobRequest req) This API is used to create a migration check task.
CreateMigrateJobResponse	CreateMigrateJob(CreateMigrateJobRequest req) This API (CreateMigrateJob) is used to create a data migration task.
CreateSubscribeResponse	CreateSubscribe(CreateSubscribeRequest req) This API is used to create a data subscription instance.
CreateSyncCheckJobResponse	CreateSyncCheckJob(CreateSyncCheckJobRequest req) Before the StartSyncJob API is called to start disaster recovery sync, this API should be called first to create a check.
CreateSyncJobResponse	CreateSyncJob(CreateSyncJobRequest req) This API (CreateSyncJob) is used to create a disaster recovery sync task.
DeleteMigrateJobResponse	DeleteMigrateJob(DeleteMigrateJobRequest req) This API (DeleteMigrationJob) is used to delete a data migration task.
DeleteSyncJobResponse	DeleteSyncJob(DeleteSyncJobRequest req) This API is used to delete a disaster recovery sync task.
DescribeAsyncRequestInfoResponse	DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req) This API is used to query the execution result of a task.
DescribeMigrateCheckJobResponse	DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req) This API is used to get the check result and query check status and progress after a check is created.
DescribeMigrateJobsResponse	DescribeMigrateJobs(DescribeMigrateJobsRequest req) This API is used to query data migration tasks.
DescribeRegionConfResponse	DescribeRegionConf(DescribeRegionConfRequest req) This API is used to query the purchasable subscription instance regions.
DescribeSubscribeConfResponse	DescribeSubscribeConf(DescribeSubscribeConfRequest req) This API is used to query the subscription instance configuration.
DescribeSubscribesResponse	DescribeSubscribes(DescribeSubscribesRequest req) This API is used to get the information list of data subscription instances.
DescribeSyncCheckJobResponse	DescribeSyncCheckJob(DescribeSyncCheckJobRequest req) This API is used to get the check result after a disaster recovery sync check task is created through the CreateSyncCheckJob API.
DescribeSyncJobsResponse	DescribeSyncJobs(DescribeSyncJobsRequest req) This API is used to query disaster recovery sync tasks initiated on the DTS platform.
IsolateSubscribeResponse	IsolateSubscribe(IsolateSubscribeRequest req) This API is used to isolate an hourly billed subscription instance.
ModifyMigrateJobResponse	ModifyMigrateJob(ModifyMigrateJobRequest req) This API (ModifyMigrateJob) is used to modify a data migration task.
ModifySubscribeConsumeTimeResponse	ModifySubscribeConsumeTime(ModifySubscribeConsumeTimeRequest req) This API is used to modify the consumption time point of a data subscription channel.
ModifySubscribeNameResponse	ModifySubscribeName(ModifySubscribeNameRequest req) This API is used to rename a data subscription instance.
ModifySubscribeObjectsResponse	ModifySubscribeObjects(ModifySubscribeObjectsRequest req) This API is used to modify the subscription rule of a data subscription channel.
ModifySubscribeVipVportResponse	ModifySubscribeVipVport(ModifySubscribeVipVportRequest req) This API is used to modify the IP and port number of a data subscription instance.
ModifySyncJobResponse	ModifySyncJob(ModifySyncJobRequest req) This API is used to modify a disaster recovery sync task.
OfflineIsolatedSubscribeResponse	OfflineIsolatedSubscribe(OfflineIsolatedSubscribeRequest req) This API is used to deactivate an isolated data subscription instance.
ResetSubscribeResponse	ResetSubscribe(ResetSubscribeRequest req) This API is used to reset a data subscription instance.
StartMigrateJobResponse	StartMigrateJob(StartMigrateJobRequest req) This API (StartMigrationJob) is used to start a migration task.
StartSyncJobResponse	StartSyncJob(StartSyncJobRequest req) This API is used to start a disaster recovery sync task after it is successfully checked through the CreateSyncCheckJob and DescribeSyncCheckJob APIs.
StopMigrateJobResponse	StopMigrateJob(StopMigrateJobRequest req) This API (StopMigrateJob) is used to cancel a data migration task.
SwitchDrToMasterResponse	SwitchDrToMaster(SwitchDrToMasterRequest req) This API is used to promote a disaster recovery instance to a master instance, which will stop sync from the original master instance and end the master/slave relationship.

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

DtsClient

public DtsClient(Credential credential,
                 String region)

DtsClient

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

Method Detail

ActivateSubscribe

public ActivateSubscribeResponse ActivateSubscribe(ActivateSubscribeRequest req)
                                            throws TencentCloudSDKException

This API is used to configure a data subscription, which can be called only for subscription instances in unconfigured status.

Parameters:

req - ActivateSubscribeRequest

Returns:

ActivateSubscribeResponse

Throws:

TencentCloudSDKException

CompleteMigrateJob

public CompleteMigrateJobResponse CompleteMigrateJob(CompleteMigrateJobRequest req)
                                              throws TencentCloudSDKException

This API (CompleteMigrateJob) is used to complete a data migration task. For tasks in incremental migration mode, you need to call this API before migration gets ready, so as to stop migrating incremental data. If the task status queried through the (DescribeMigrateJobs) API is ready (status=8), you can call this API to complete the migration task.

Parameters:

req - CompleteMigrateJobRequest

Returns:

CompleteMigrateJobResponse

Throws:

TencentCloudSDKException

CreateMigrateCheckJob

public CreateMigrateCheckJobResponse CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)
                                                    throws TencentCloudSDKException

This API is used to create a migration check task. Before migration, you should call this API to create a check. Migration will start only if the check succeeds. You can view the check result through the DescribeMigrateCheckJob API. After successful check, if the migration task needs to be modified, a new check task should be created and migration will begin only after the new check succeeds.

Parameters:

req - CreateMigrateCheckJobRequest

Returns:

CreateMigrateCheckJobResponse

Throws:

TencentCloudSDKException

CreateMigrateJob

public CreateMigrateJobResponse CreateMigrateJob(CreateMigrateJobRequest req)
                                          throws TencentCloudSDKException

This API (CreateMigrateJob) is used to create a data migration task. For a finance zone linkage, please use the domain name dts.ap-shenzhen-fsi.tencentcloudapi.com.

Parameters:

req - CreateMigrateJobRequest

Returns:

CreateMigrateJobResponse

Throws:

TencentCloudSDKException

CreateSubscribe

public CreateSubscribeResponse CreateSubscribe(CreateSubscribeRequest req)
                                        throws TencentCloudSDKException

This API is used to create a data subscription instance.

Parameters:

req - CreateSubscribeRequest

Returns:

CreateSubscribeResponse

Throws:

TencentCloudSDKException

CreateSyncCheckJob

public CreateSyncCheckJobResponse CreateSyncCheckJob(CreateSyncCheckJobRequest req)
                                              throws TencentCloudSDKException

Before the StartSyncJob API is called to start disaster recovery sync, this API should be called first to create a check. Data sync can start only if the check succeeds. You can view the check result through the DescribeSyncCheckJob API. Sync can begin only if the check succeeds.

Parameters:

req - CreateSyncCheckJobRequest

Returns:

CreateSyncCheckJobResponse

Throws:

TencentCloudSDKException

CreateSyncJob

public CreateSyncJobResponse CreateSyncJob(CreateSyncJobRequest req)
                                    throws TencentCloudSDKException

This API (CreateSyncJob) is used to create a disaster recovery sync task. After successful creation, check can be initiated through the CreateSyncCheckJob API. The sync task can be started through the StartSyncJob API only if the check succeeds.

Parameters:

req - CreateSyncJobRequest

Returns:

CreateSyncJobResponse

Throws:

TencentCloudSDKException

DeleteMigrateJob

public DeleteMigrateJobResponse DeleteMigrateJob(DeleteMigrateJobRequest req)
                                          throws TencentCloudSDKException

This API (DeleteMigrationJob) is used to delete a data migration task. If the task status queried through the DescribeMigrateJobs API is checking (status=3), running (status=7), ready (status=8), canceling (status=11), or completing (status=12), the task cannot be deleted.

Parameters:

req - DeleteMigrateJobRequest

Returns:

DeleteMigrateJobResponse

Throws:

TencentCloudSDKException

DeleteSyncJob

public DeleteSyncJobResponse DeleteSyncJob(DeleteSyncJobRequest req)
                                    throws TencentCloudSDKException

This API is used to delete a disaster recovery sync task. Sync tasks that are running cannot be deleted.

Parameters:

req - DeleteSyncJobRequest

Returns:

DeleteSyncJobResponse

Throws:

TencentCloudSDKException

DescribeAsyncRequestInfo

public DescribeAsyncRequestInfoResponse DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
                                                          throws TencentCloudSDKException

This API is used to query the execution result of a task.

Parameters:

req - DescribeAsyncRequestInfoRequest

Returns:

DescribeAsyncRequestInfoResponse

Throws:

TencentCloudSDKException

DescribeMigrateCheckJob

public DescribeMigrateCheckJobResponse DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req)
                                                        throws TencentCloudSDKException

This API is used to get the check result and query check status and progress after a check is created. If the check succeeds, you can call the StartMigrateJob API to start migration. If the check fails, the reason can be queried. Please modify the migration configuration or adjust relevant parameters of the source/target instances through the ModifyMigrateJob API based on the error message.

Parameters:

req - DescribeMigrateCheckJobRequest

Returns:

DescribeMigrateCheckJobResponse

Throws:

TencentCloudSDKException

DescribeMigrateJobs

public DescribeMigrateJobsResponse DescribeMigrateJobs(DescribeMigrateJobsRequest req)
                                                throws TencentCloudSDKException

This API is used to query data migration tasks. For a finance zone linkage, please use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.

Parameters:

req - DescribeMigrateJobsRequest

Returns:

DescribeMigrateJobsResponse

Throws:

TencentCloudSDKException

DescribeRegionConf

public DescribeRegionConfResponse DescribeRegionConf(DescribeRegionConfRequest req)
                                              throws TencentCloudSDKException

This API is used to query the purchasable subscription instance regions.

Parameters:

req - DescribeRegionConfRequest

Returns:

DescribeRegionConfResponse

Throws:

TencentCloudSDKException

DescribeSubscribeConf

public DescribeSubscribeConfResponse DescribeSubscribeConf(DescribeSubscribeConfRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the subscription instance configuration.

Parameters:

req - DescribeSubscribeConfRequest

Returns:

DescribeSubscribeConfResponse

Throws:

TencentCloudSDKException

DescribeSubscribes

public DescribeSubscribesResponse DescribeSubscribes(DescribeSubscribesRequest req)
                                              throws TencentCloudSDKException

This API is used to get the information list of data subscription instances. Pagination is enabled by default with 20 results returned each time.

Parameters:

req - DescribeSubscribesRequest

Returns:

DescribeSubscribesResponse

Throws:

TencentCloudSDKException

DescribeSyncCheckJob

public DescribeSyncCheckJobResponse DescribeSyncCheckJob(DescribeSyncCheckJobRequest req)
                                                  throws TencentCloudSDKException

This API is used to get the check result after a disaster recovery sync check task is created through the CreateSyncCheckJob API. Check status and progress can be queried. If the check succeeds, you can call the StartSyncJob API to start the sync task. If the check fails, the reason will be returned. You can modify the configuration through the ModifySyncJob API and initiate check again. It takes about 30 seconds to complete the check task. If the returned status is not "finished", the check has not been completed, and this API needs to be polled. If Status=finished and CheckFlag=1, the check succeeds. If Status=finished and CheckFlag !=1, the check fails.

Parameters:

req - DescribeSyncCheckJobRequest

Returns:

DescribeSyncCheckJobResponse

Throws:

TencentCloudSDKException

DescribeSyncJobs

public DescribeSyncJobsResponse DescribeSyncJobs(DescribeSyncJobsRequest req)
                                          throws TencentCloudSDKException

This API is used to query disaster recovery sync tasks initiated on the DTS platform.

Parameters:

req - DescribeSyncJobsRequest

Returns:

DescribeSyncJobsResponse

Throws:

TencentCloudSDKException

IsolateSubscribe

public IsolateSubscribeResponse IsolateSubscribe(IsolateSubscribeRequest req)
                                          throws TencentCloudSDKException

This API is used to isolate an hourly billed subscription instance. After this API is called, the instance will become unavailable and billing will stop for it.

Parameters:

req - IsolateSubscribeRequest

Returns:

IsolateSubscribeResponse

Throws:

TencentCloudSDKException

ModifyMigrateJob

public ModifyMigrateJobResponse ModifyMigrateJob(ModifyMigrateJobRequest req)
                                          throws TencentCloudSDKException

This API (ModifyMigrateJob) is used to modify a data migration task. If the status of a migration task is creating (status=1), check succeeded (status=4), check failed (status=5), or migration failed (status=10), this API can be called to modify the task, but the type of the source and target instances and the region of the target instance cannot be modified. For a finance zone linkage, please use the domain name dts.ap-shenzhen-fsi.tencentcloudapi.com.

Parameters:

req - ModifyMigrateJobRequest

Returns:

ModifyMigrateJobResponse

Throws:

TencentCloudSDKException

ModifySubscribeConsumeTime

public ModifySubscribeConsumeTimeResponse ModifySubscribeConsumeTime(ModifySubscribeConsumeTimeRequest req)
                                                              throws TencentCloudSDKException

This API is used to modify the consumption time point of a data subscription channel.

Parameters:

req - ModifySubscribeConsumeTimeRequest

Returns:

ModifySubscribeConsumeTimeResponse

Throws:

TencentCloudSDKException

ModifySubscribeName

public ModifySubscribeNameResponse ModifySubscribeName(ModifySubscribeNameRequest req)
                                                throws TencentCloudSDKException

This API is used to rename a data subscription instance.

Parameters:

req - ModifySubscribeNameRequest

Returns:

ModifySubscribeNameResponse

Throws:

TencentCloudSDKException

ModifySubscribeObjects

public ModifySubscribeObjectsResponse ModifySubscribeObjects(ModifySubscribeObjectsRequest req)
                                                      throws TencentCloudSDKException

This API is used to modify the subscription rule of a data subscription channel.

Parameters:

req - ModifySubscribeObjectsRequest

Returns:

ModifySubscribeObjectsResponse

Throws:

TencentCloudSDKException

ModifySubscribeVipVport

public ModifySubscribeVipVportResponse ModifySubscribeVipVport(ModifySubscribeVipVportRequest req)
                                                        throws TencentCloudSDKException

This API is used to modify the IP and port number of a data subscription instance.

Parameters:

req - ModifySubscribeVipVportRequest

Returns:

ModifySubscribeVipVportResponse

Throws:

TencentCloudSDKException

ModifySyncJob

public ModifySyncJobResponse ModifySyncJob(ModifySyncJobRequest req)
                                    throws TencentCloudSDKException

This API is used to modify a disaster recovery sync task. If the status of a sync task is creating, created, check succeeded, or check failed, this API can be called to modify the task. The information of the source and target instances cannot be modified, but the task name and the tables to be synced can.

Parameters:

req - ModifySyncJobRequest

Returns:

ModifySyncJobResponse

Throws:

TencentCloudSDKException

OfflineIsolatedSubscribe

public OfflineIsolatedSubscribeResponse OfflineIsolatedSubscribe(OfflineIsolatedSubscribeRequest req)
                                                          throws TencentCloudSDKException

This API is used to deactivate an isolated data subscription instance.

Parameters:

req - OfflineIsolatedSubscribeRequest

Returns:

OfflineIsolatedSubscribeResponse

Throws:

TencentCloudSDKException

ResetSubscribe

public ResetSubscribeResponse ResetSubscribe(ResetSubscribeRequest req)
                                      throws TencentCloudSDKException

This API is used to reset a data subscription instance. Once reset, an activated instance can be bound to other database instances through the `ActivateSubscribe` API.

Parameters:

req - ResetSubscribeRequest

Returns:

ResetSubscribeResponse

Throws:

TencentCloudSDKException

StartMigrateJob

public StartMigrateJobResponse StartMigrateJob(StartMigrateJobRequest req)
                                        throws TencentCloudSDKException

This API (StartMigrationJob) is used to start a migration task. After the API is called, non-scheduled migration tasks will start the migration immediately, while scheduled tasks will start the countdown. Before calling this API, be sure to use the CreateMigrateCheckJob API to check the data migration task, which can be started only if its status queried through the DescribeMigrateJobs API is check succeeded (status=4).

Parameters:

req - StartMigrateJobRequest

Returns:

StartMigrateJobResponse

Throws:

TencentCloudSDKException

StartSyncJob

public StartSyncJobResponse StartSyncJob(StartSyncJobRequest req)
                                  throws TencentCloudSDKException

This API is used to start a disaster recovery sync task after it is successfully checked through the CreateSyncCheckJob and DescribeSyncCheckJob APIs.

Parameters:

req - StartSyncJobRequest

Returns:

StartSyncJobResponse

Throws:

TencentCloudSDKException

StopMigrateJob

public StopMigrateJobResponse StopMigrateJob(StopMigrateJobRequest req)
                                      throws TencentCloudSDKException

This API (StopMigrateJob) is used to cancel a data migration task. During migration, this API can be used to cancel migration if the task status queried through the DescribeMigrateJobs API is running (status=7) or ready (status=8), and the migration task will fail.

Parameters:

req - StopMigrateJobRequest

Returns:

StopMigrateJobResponse

Throws:

TencentCloudSDKException

SwitchDrToMaster

public SwitchDrToMasterResponse SwitchDrToMaster(SwitchDrToMasterRequest req)
                                          throws TencentCloudSDKException

This API is used to promote a disaster recovery instance to a master instance, which will stop sync from the original master instance and end the master/slave relationship.

Parameters:

req - SwitchDrToMasterRequest

Returns:

SwitchDrToMasterResponse

Throws:

TencentCloudSDKException