com.tencentcloudapi.dts.v20211206

Class DtsClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.dts.v20211206.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
CompleteMigrateJobResponse	CompleteMigrateJob(CompleteMigrateJobRequest req) This API is used to complete a data migration task.
ConfigureSyncJobResponse	ConfigureSyncJob(ConfigureSyncJobRequest req) This API is used to configure a sync task.
CreateCheckSyncJobResponse	CreateCheckSyncJob(CreateCheckSyncJobRequest req) This API is used to verify a sync task by checking required parameters and peripheral configuration.
CreateCompareTaskResponse	CreateCompareTask(CreateCompareTaskRequest req) This API is used to create a data consistency check task.
CreateMigrateCheckJobResponse	CreateMigrateCheckJob(CreateMigrateCheckJobRequest req) This API is used to verify a migration task.
CreateMigrationServiceResponse	CreateMigrationService(CreateMigrationServiceRequest req) This API is used to purchase migration tasks.
CreateSyncJobResponse	CreateSyncJob(CreateSyncJobRequest req) This API is used to create a sync task.
DeleteCompareTaskResponse	DeleteCompareTask(DeleteCompareTaskRequest req) This API is used to delete a data consistency check task, which can be called when the task status is `success`, `failed`, or `canceled`.
DescribeCheckSyncJobResultResponse	DescribeCheckSyncJobResult(DescribeCheckSyncJobResultRequest req) This API is used to query the result of a sync check task.
DescribeCompareReportResponse	DescribeCompareReport(DescribeCompareReportRequest req) This API is used to query the details of a data consistency check task.
DescribeCompareTasksResponse	DescribeCompareTasks(DescribeCompareTasksRequest req) This API is used to query the list of data consistency check tasks under the current task.
DescribeMigrateDBInstancesResponse	DescribeMigrateDBInstances(DescribeMigrateDBInstancesRequest req) This API is used to query migratable database instances.
DescribeMigrationCheckJobResponse	DescribeMigrationCheckJob(DescribeMigrationCheckJobRequest req) This API is used to get the check result and query the check status and progress after a check is created.
DescribeMigrationDetailResponse	DescribeMigrationDetail(DescribeMigrationDetailRequest req) This API is used to query the details of a migration task.
DescribeMigrationJobsResponse	DescribeMigrationJobs(DescribeMigrationJobsRequest req) This API is used to query the list of data migration tasks.
DescribeSyncJobsResponse	DescribeSyncJobs(DescribeSyncJobsRequest req) This API is used to query the information of a sync task.
DestroyMigrateJobResponse	DestroyMigrateJob(DestroyMigrateJobRequest req) This API is used to delete a data migration task.
DestroySyncJobResponse	DestroySyncJob(DestroySyncJobRequest req) This API is used to delete a sync task.
IsolateMigrateJobResponse	IsolateMigrateJob(IsolateMigrateJobRequest req) This API is used to isolate and return a data migration task.
IsolateSyncJobResponse	IsolateSyncJob(IsolateSyncJobRequest req) This API is used to isolate a sync task.
ModifyCompareTaskResponse	ModifyCompareTask(ModifyCompareTaskRequest req) This API is used to modify the parameters of a data consistency check task after it is created and before it starts.
ModifyCompareTaskNameResponse	ModifyCompareTaskName(ModifyCompareTaskNameRequest req) This API is used to rename a data consistency check task.
ModifyMigrateJobSpecResponse	ModifyMigrateJobSpec(ModifyMigrateJobSpecRequest req) This API is used to adjust the specification of a pay-as-you-go task.
ModifyMigrateNameResponse	ModifyMigrateName(ModifyMigrateNameRequest req) This API is used to rename a migration task.
ModifyMigrationJobResponse	ModifyMigrationJob(ModifyMigrationJobRequest req) This API is used to configure a migration task.
RecoverMigrateJobResponse	RecoverMigrateJob(RecoverMigrateJobRequest req) This API is used to recover a data migration task in **Isolated** status.
RecoverSyncJobResponse	RecoverSyncJob(RecoverSyncJobRequest req) This API is used to recover a sync task in **Isolated** status.
ResizeSyncJobResponse	ResizeSyncJob(ResizeSyncJobRequest req) This API is used to adjust the specification of a pay-as-you-go sync task.
ResumeMigrateJobResponse	ResumeMigrateJob(ResumeMigrateJobRequest req) This API is used to retry an abnormal or failed Redis data migration task.
ResumeSyncJobResponse	ResumeSyncJob(ResumeSyncJobRequest req) This API is used to retry a sync task after certain resolvable errors are reported.
SkipCheckItemResponse	SkipCheckItem(SkipCheckItemRequest req) This API is used for the backend to skip a failed check item.
SkipSyncCheckItemResponse	SkipSyncCheckItem(SkipSyncCheckItemRequest req) This API is used for the backend to skip a failed check item.
StartCompareResponse	StartCompare(StartCompareRequest req) This API is used to start a data consistency check task after creating it by calling the `CreateCompareTask` API.
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 sync task.
StopCompareResponse	StopCompare(StopCompareRequest req) This API is used to stop a data consistency check task.
StopMigrateJobResponse	StopMigrateJob(StopMigrateJobRequest req) This API is used to stop a data migration task.
StopSyncJobResponse	StopSyncJob(StopSyncJobRequest req) This API is used to stop a sync task.

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

CompleteMigrateJob

public CompleteMigrateJobResponse CompleteMigrateJob(CompleteMigrateJobRequest req)
                                              throws TencentCloudSDKException

This API is used to complete a data migration task. For tasks in incremental migration mode, you need to call this API before migration gets ready for completion to stop migrating incremental data. If the task status queried through the `DescribeMigrationJobs` API is ready (`Status` = `readyComplete), you can call this API to complete the migration task.

Parameters:

req - CompleteMigrateJobRequest

Returns:

CompleteMigrateJobResponse

Throws:

TencentCloudSDKException

ConfigureSyncJob

public ConfigureSyncJobResponse ConfigureSyncJob(ConfigureSyncJobRequest req)
                                          throws TencentCloudSDKException

This API is used to configure a sync task.

Parameters:

req - ConfigureSyncJobRequest

Returns:

ConfigureSyncJobResponse

Throws:

TencentCloudSDKException

CreateCheckSyncJob

public CreateCheckSyncJobResponse CreateCheckSyncJob(CreateCheckSyncJobRequest req)
                                              throws TencentCloudSDKException

This API is used to verify a sync task by checking required parameters and peripheral configuration.

Parameters:

req - CreateCheckSyncJobRequest

Returns:

CreateCheckSyncJobResponse

Throws:

TencentCloudSDKException

CreateCompareTask

public CreateCompareTaskResponse CreateCompareTask(CreateCompareTaskRequest req)
                                            throws TencentCloudSDKException

This API is used to create a data consistency check task. After the task is successfully created, its ID will be returned in the format of `dts-8yv4w2i1-cmp-37skmii9`, and you can call `StartCompare` to start it.

Parameters:

req - CreateCompareTaskRequest

Returns:

CreateCompareTaskResponse

Throws:

TencentCloudSDKException

CreateMigrateCheckJob

public CreateMigrateCheckJobResponse CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)
                                                    throws TencentCloudSDKException

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

Parameters:

req - CreateMigrateCheckJobRequest

Returns:

CreateMigrateCheckJobResponse

Throws:

TencentCloudSDKException

CreateMigrationService

public CreateMigrationServiceResponse CreateMigrationService(CreateMigrationServiceRequest req)
                                                      throws TencentCloudSDKException

This API is used to purchase migration tasks. After the tasks are purchased successfully, a randomly generated list of task IDs will be returned. You can also call the `DescribeMigrationJobs` API to query the IDs of the successfully purchased tasks. Note that once a task is purchased successfully, the types and regions of the source and target databases cannot be changed.

Parameters:

req - CreateMigrationServiceRequest

Returns:

CreateMigrationServiceResponse

Throws:

TencentCloudSDKException

CreateSyncJob

public CreateSyncJobResponse CreateSyncJob(CreateSyncJobRequest req)
                                    throws TencentCloudSDKException

This API is used to create a sync task.

Parameters:

req - CreateSyncJobRequest

Returns:

CreateSyncJobResponse

Throws:

TencentCloudSDKException

DeleteCompareTask

public DeleteCompareTaskResponse DeleteCompareTask(DeleteCompareTaskRequest req)
                                            throws TencentCloudSDKException

This API is used to delete a data consistency check task, which can be called when the task status is `success`, `failed`, or `canceled`.

Parameters:

req - DeleteCompareTaskRequest

Returns:

DeleteCompareTaskResponse

Throws:

TencentCloudSDKException

DescribeCheckSyncJobResult

public DescribeCheckSyncJobResultResponse DescribeCheckSyncJobResult(DescribeCheckSyncJobResultRequest req)
                                                              throws TencentCloudSDKException

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

Parameters:

req - DescribeCheckSyncJobResultRequest

Returns:

DescribeCheckSyncJobResultResponse

Throws:

TencentCloudSDKException

DescribeCompareReport

public DescribeCompareReportResponse DescribeCompareReport(DescribeCompareReportRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the details of a data consistency check task.

Parameters:

req - DescribeCompareReportRequest

Returns:

DescribeCompareReportResponse

Throws:

TencentCloudSDKException

DescribeCompareTasks

public DescribeCompareTasksResponse DescribeCompareTasks(DescribeCompareTasksRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the list of data consistency check tasks under the current task.

Parameters:

req - DescribeCompareTasksRequest

Returns:

DescribeCompareTasksResponse

Throws:

TencentCloudSDKException

DescribeMigrateDBInstances

public DescribeMigrateDBInstancesResponse DescribeMigrateDBInstances(DescribeMigrateDBInstancesRequest req)
                                                              throws TencentCloudSDKException

This API is used to query migratable database instances.

Parameters:

req - DescribeMigrateDBInstancesRequest

Returns:

DescribeMigrateDBInstancesResponse

Throws:

TencentCloudSDKException

DescribeMigrationCheckJob

public DescribeMigrationCheckJobResponse DescribeMigrationCheckJob(DescribeMigrationCheckJobRequest req)
                                                            throws TencentCloudSDKException

This API is used to get the check result and query the 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 cause can be queried. Modify the migration configuration or adjust relevant parameters of the source/target instances through the `ModifyMigrationJob` API based on the error message.

Parameters:

req - DescribeMigrationCheckJobRequest

Returns:

DescribeMigrationCheckJobResponse

Throws:

TencentCloudSDKException

DescribeMigrationDetail

public DescribeMigrationDetailResponse DescribeMigrationDetail(DescribeMigrationDetailRequest req)
                                                        throws TencentCloudSDKException

This API is used to query the details of a migration task.

Parameters:

req - DescribeMigrationDetailRequest

Returns:

DescribeMigrationDetailResponse

Throws:

TencentCloudSDKException

DescribeMigrationJobs

public DescribeMigrationJobsResponse DescribeMigrationJobs(DescribeMigrationJobsRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the list of data migration tasks.

Parameters:

req - DescribeMigrationJobsRequest

Returns:

DescribeMigrationJobsResponse

Throws:

TencentCloudSDKException

DescribeSyncJobs

public DescribeSyncJobsResponse DescribeSyncJobs(DescribeSyncJobsRequest req)
                                          throws TencentCloudSDKException

This API is used to query the information of a sync task.

Parameters:

req - DescribeSyncJobsRequest

Returns:

DescribeSyncJobsResponse

Throws:

TencentCloudSDKException

DestroyMigrateJob

public DestroyMigrateJobResponse DestroyMigrateJob(DestroyMigrateJobRequest req)
                                            throws TencentCloudSDKException

This API is used to delete a data migration task. For a billed task, you must first call the `IsolateMigrateJob` API to isolate it and make sure that it is in **Isolated** status before calling this API to delete it. For a free task, you can directly call the `IsolateMigrateJob` API to delete it.

Parameters:

req - DestroyMigrateJobRequest

Returns:

DestroyMigrateJobResponse

Throws:

TencentCloudSDKException

DestroySyncJob

public DestroySyncJobResponse DestroySyncJob(DestroySyncJobRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a sync task. Only tasks in **Isolated** status can be completely deleted. After deletion, you can call the `DescribeSyncJobs` API to get the task list. If the deleted task is not in the list, it is deleted successfully.

Parameters:

req - DestroySyncJobRequest

Returns:

DestroySyncJobResponse

Throws:

TencentCloudSDKException

IsolateMigrateJob

public IsolateMigrateJobResponse IsolateMigrateJob(IsolateMigrateJobRequest req)
                                            throws TencentCloudSDKException

This API is used to isolate and return a data migration task. After calling this API, you can call the `DescribeMigrationJobs` API to query the latest task status. For a billed task, after isolating it, you can call `RecoverMigrationJob` to recover it or call `DestroyMigrateJob` to delete it. For a free task, calling this API will directly delete it permanently.

Parameters:

req - IsolateMigrateJobRequest

Returns:

IsolateMigrateJobResponse

Throws:

TencentCloudSDKException

IsolateSyncJob

public IsolateSyncJobResponse IsolateSyncJob(IsolateSyncJobRequest req)
                                      throws TencentCloudSDKException

This API is used to isolate a sync task. After the task is isolated, you can call the `DescribeSyncJobs` API to query its status, call `RecoverSyncJob` to recover it, or directly delete it. For a free task, calling this API will directly delete it permanently.

Parameters:

req - IsolateSyncJobRequest

Returns:

IsolateSyncJobResponse

Throws:

TencentCloudSDKException

ModifyCompareTask

public ModifyCompareTaskResponse ModifyCompareTask(ModifyCompareTaskRequest req)
                                            throws TencentCloudSDKException

This API is used to modify the parameters of a data consistency check task after it is created and before it starts.

Parameters:

req - ModifyCompareTaskRequest

Returns:

ModifyCompareTaskResponse

Throws:

TencentCloudSDKException

ModifyCompareTaskName

public ModifyCompareTaskNameResponse ModifyCompareTaskName(ModifyCompareTaskNameRequest req)
                                                    throws TencentCloudSDKException

This API is used to rename a data consistency check task.

Parameters:

req - ModifyCompareTaskNameRequest

Returns:

ModifyCompareTaskNameResponse

Throws:

TencentCloudSDKException

ModifyMigrateJobSpec

public ModifyMigrateJobSpecResponse ModifyMigrateJobSpec(ModifyMigrateJobSpecRequest req)
                                                  throws TencentCloudSDKException

This API is used to adjust the specification of a pay-as-you-go task. After calling this API, you can call the `DescribeMigrationJobs` API to query the latest task status.

Parameters:

req - ModifyMigrateJobSpecRequest

Returns:

ModifyMigrateJobSpecResponse

Throws:

TencentCloudSDKException

ModifyMigrateName

public ModifyMigrateNameResponse ModifyMigrateName(ModifyMigrateNameRequest req)
                                            throws TencentCloudSDKException

This API is used to rename a migration task.

Parameters:

req - ModifyMigrateNameRequest

Returns:

ModifyMigrateNameResponse

Throws:

TencentCloudSDKException

ModifyMigrationJob

public ModifyMigrationJobResponse ModifyMigrationJob(ModifyMigrationJobRequest req)
                                              throws TencentCloudSDKException

This API is used to configure a migration task. After it is configured successfully, you can call the `CreateMigrationCheckJob` API to create a check task, and only after it passes the check can it be started.

Parameters:

req - ModifyMigrationJobRequest

Returns:

ModifyMigrationJobResponse

Throws:

TencentCloudSDKException

RecoverMigrateJob

public RecoverMigrateJobResponse RecoverMigrateJob(RecoverMigrateJobRequest req)
                                            throws TencentCloudSDKException

This API is used to recover a data migration task in **Isolated** status. After calling this API, you can call the `DescribeMigrationJobs` API to query the latest task status.

Parameters:

req - RecoverMigrateJobRequest

Returns:

RecoverMigrateJobResponse

Throws:

TencentCloudSDKException

RecoverSyncJob

public RecoverSyncJobResponse RecoverSyncJob(RecoverSyncJobRequest req)
                                      throws TencentCloudSDKException

This API is used to recover a sync task in **Isolated** status. After calling this API, you can call the `DescribeSyncJobs` API to query the latest task status.

Parameters:

req - RecoverSyncJobRequest

Returns:

RecoverSyncJobResponse

Throws:

TencentCloudSDKException

ResizeSyncJob

public ResizeSyncJobResponse ResizeSyncJob(ResizeSyncJobRequest req)
                                    throws TencentCloudSDKException

This API is used to adjust the specification of a pay-as-you-go sync task. After this API is called, the backend needs to take about 3-5 minutes to implement the adjustment. You can call the `DescribeSyncJobs` API to query the latest task status.

Parameters:

req - ResizeSyncJobRequest

Returns:

ResizeSyncJobResponse

Throws:

TencentCloudSDKException

ResumeMigrateJob

public ResumeMigrateJobResponse ResumeMigrateJob(ResumeMigrateJobRequest req)
                                          throws TencentCloudSDKException

This API is used to retry an abnormal or failed Redis data migration task. Note that this operation will skip the check stage and directly start the task, just like by calling `StartMigrationJob`. After calling this API, you can call the `DescribeMigrationJobs` API to query the latest task status.

Parameters:

req - ResumeMigrateJobRequest

Returns:

ResumeMigrateJobResponse

Throws:

TencentCloudSDKException

ResumeSyncJob

public ResumeSyncJobResponse ResumeSyncJob(ResumeSyncJobRequest req)
                                    throws TencentCloudSDKException

This API is used to retry a sync task after certain resolvable errors are reported. After calling this API, you can call the `DescribeSyncJobs` API to query the latest task status.

Parameters:

req - ResumeSyncJobRequest

Returns:

ResumeSyncJobResponse

Throws:

TencentCloudSDKException

SkipCheckItem

public SkipCheckItemResponse SkipCheckItem(SkipCheckItemRequest req)
                                    throws TencentCloudSDKException

This API is used for the backend to skip a failed check item. Theoretically, to execute a migration task normally, any check step cannot be skipped, and the check must be passed. For products or links that support check item skipping, see [Check Item Overview](https://www.tencentcloud.com/document/product/571/42551).

Parameters:

req - SkipCheckItemRequest

Returns:

SkipCheckItemResponse

Throws:

TencentCloudSDKException

SkipSyncCheckItem

public SkipSyncCheckItemResponse SkipSyncCheckItem(SkipSyncCheckItemRequest req)
                                            throws TencentCloudSDKException

This API is used for the backend to skip a failed check item. Theoretically, to execute a sync task normally, any check step cannot be skipped, and the check must be passed. For products or links that support check item skipping, see [Check Item Overview](https://www.tencentcloud.com/document/product/571/42551).

Parameters:

req - SkipSyncCheckItemRequest

Returns:

SkipSyncCheckItemResponse

Throws:

TencentCloudSDKException

StartCompare

public StartCompareResponse StartCompare(StartCompareRequest req)
                                  throws TencentCloudSDKException

This API is used to start a data consistency check task after creating it by calling the `CreateCompareTask` API. After calling this API, you can call the `DescribeCompareTasks` API to query the latest task status.

Parameters:

req - StartCompareRequest

Returns:

StartCompareResponse

Throws:

TencentCloudSDKException

StartMigrateJob

public StartMigrateJobResponse StartMigrateJob(StartMigrateJobRequest req)
                                        throws TencentCloudSDKException

This API (`StartMigrationJob`) is used to start a migration task. After calling this API, you can call the `DescribeMigrationJobs` API to query the latest task status.

Parameters:

req - StartMigrateJobRequest

Returns:

StartMigrateJobResponse

Throws:

TencentCloudSDKException

StartSyncJob

public StartSyncJobResponse StartSyncJob(StartSyncJobRequest req)
                                  throws TencentCloudSDKException

This API is used to start a sync task.

Parameters:

req - StartSyncJobRequest

Returns:

StartSyncJobResponse

Throws:

TencentCloudSDKException

StopCompare

public StopCompareResponse StopCompare(StopCompareRequest req)
                                throws TencentCloudSDKException

This API is used to stop a data consistency check task.

Parameters:

req - StopCompareRequest

Returns:

StopCompareResponse

Throws:

TencentCloudSDKException

StopMigrateJob

public StopMigrateJobResponse StopMigrateJob(StopMigrateJobRequest req)
                                      throws TencentCloudSDKException

This API is used to stop a data migration task. After calling this API, you can call the `DescribeMigrationJobs` API to query the latest task status.

Parameters:

req - StopMigrateJobRequest

Returns:

StopMigrateJobResponse

Throws:

TencentCloudSDKException

StopSyncJob

public StopSyncJobResponse StopSyncJob(StopSyncJobRequest req)
                                throws TencentCloudSDKException

This API is used to stop a sync task. After calling this API, you can call the `DescribeSyncJobs` API to query the latest task status.

Parameters:

req - StopSyncJobRequest

Returns:

StopSyncJobResponse

Throws:

TencentCloudSDKException