DtsClient (tencentcloud-sdk-java 3.1.906 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompleteMigrateJobResponse`	`CompleteMigrateJob(CompleteMigrateJobRequest req)` 本接口（CompleteMigrateJob）用于完成数据迁移任务。选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。通过DescribeMigrationJobs接口查询到任务的状态为准备完成（Status="readyComplete"）时，此时可以调用本接口完成迁移任务。
`ConfigureSyncJobResponse`	`ConfigureSyncJob(ConfigureSyncJobRequest req)` 配置一个同步任务
`ContinueMigrateJobResponse`	`ContinueMigrateJob(ContinueMigrateJobRequest req)` 恢复一个暂停中的迁移任务。
`ContinueSyncJobResponse`	`ContinueSyncJob(ContinueSyncJobRequest req)` 恢复处于已暂停状态的数据同步任务。
`CreateCheckSyncJobResponse`	`CreateCheckSyncJob(CreateCheckSyncJobRequest req)` 校验同步任务，检查必要参数和周边配置。
`CreateCompareTaskResponse`	`CreateCompareTask(CreateCompareTaskRequest req)` 本接口用于创建数据对比任务，创建成功后会返回数据对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，创建成功后可通过StartCompare启动一致性校验任务
`CreateMigrateCheckJobResponse`	`CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)` 校验迁移任务，在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移.
`CreateMigrationServiceResponse`	`CreateMigrationService(CreateMigrationServiceRequest req)` 购买迁移任务。购买成功后会返回随机生成的迁移任务id列表，也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意，一旦购买成功后源及目标数据库类型，源及目标实例地域不可修改。
`CreateModifyCheckSyncJobResponse`	`CreateModifyCheckSyncJob(CreateModifyCheckSyncJobRequest req)` 在修改同步任务的配置后、通过该接口校验当前任务是否支持修改对象操作
`CreateSyncJobResponse`	`CreateSyncJob(CreateSyncJobRequest req)` 创建一个同步任务
`DeleteCompareTaskResponse`	`DeleteCompareTask(DeleteCompareTaskRequest req)` 删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。
`DescribeCheckSyncJobResultResponse`	`DescribeCheckSyncJobResult(DescribeCheckSyncJobResultRequest req)` 查询同步校验任务结果，检查必要参数和周边配置
`DescribeCompareReportResponse`	`DescribeCompareReport(DescribeCompareReportRequest req)` 查询一致性校验任务详情
`DescribeCompareTasksResponse`	`DescribeCompareTasks(DescribeCompareTasksRequest req)` 查询一致性校验任务列表，调用该接口后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态。
`DescribeMigrateDBInstancesResponse`	`DescribeMigrateDBInstances(DescribeMigrateDBInstancesRequest req)` 本接口用于查询支持迁移的云数据库实例
`DescribeMigrationCheckJobResponse`	`DescribeMigrationCheckJob(DescribeMigrationCheckJobRequest req)` 本接口用于创建校验后,获取校验的结果.
`DescribeMigrationDetailResponse`	`DescribeMigrationDetail(DescribeMigrationDetailRequest req)` 查询某个迁移任务详情
`DescribeMigrationJobsResponse`	`DescribeMigrationJobs(DescribeMigrationJobsRequest req)` 查询数据迁移任务列表
`DescribeModifyCheckSyncJobResultResponse`	`DescribeModifyCheckSyncJobResult(DescribeModifyCheckSyncJobResultRequest req)` 在创建修改对象的校验任务后、通过该接口查看校验任务的结果
`DescribeSyncJobsResponse`	`DescribeSyncJobs(DescribeSyncJobsRequest req)` 查询同步任务信息
`DestroyMigrateJobResponse`	`DestroyMigrateJob(DestroyMigrateJobRequest req)` 下线数据迁移任务。计费任务必须先调用隔离(IsolateMigrateJob)接口，且只有是已隔离状态下，才能调用此接口销毁任务。对于不计费任务，调用隔离(IsolateMigrateJob)接口删除任务操作。
`DestroySyncJobResponse`	`DestroySyncJob(DestroySyncJobRequest req)` 下线同步任务，任务在已隔离状态下可以通过此操作进行任务下线，即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态，此操作成功后无法看到此任务表示下线成功。
`IsolateMigrateJobResponse`	`IsolateMigrateJob(IsolateMigrateJobRequest req)` 隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务，在任务隔离后可进行解除隔离(RecoverMigrationJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务，调用此接口会直接销毁任务，无法进行恢复操作。
`IsolateSyncJobResponse`	`IsolateSyncJob(IsolateSyncJobRequest req)` 隔离同步任务，隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务，调用此接口后会直接删除任务，无法进行恢复操作。
`ModifyCompareTaskResponse`	`ModifyCompareTask(ModifyCompareTaskRequest req)` 修改一致性校验任务，在任务创建后启动之前，可修改一致性校验参数
`ModifyCompareTaskNameResponse`	`ModifyCompareTaskName(ModifyCompareTaskNameRequest req)` 修改一致性校验任务名称
`ModifyMigrateJobSpecResponse`	`ModifyMigrateJobSpec(ModifyMigrateJobSpecRequest req)` 调整实例规格，此接口只支持按量计费任务的调整。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
`ModifyMigrateNameResponse`	`ModifyMigrateName(ModifyMigrateNameRequest req)` 修改迁移任务名
`ModifyMigrateRateLimitResponse`	`ModifyMigrateRateLimit(ModifyMigrateRateLimitRequest req)` 用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
`ModifyMigrateRuntimeAttributeResponse`	`ModifyMigrateRuntimeAttribute(ModifyMigrateRuntimeAttributeRequest req)` 修改任务运行时属性，此接口不同于配置类接口，不会进行状态机判断。
`ModifyMigrationJobResponse`	`ModifyMigrationJob(ModifyMigrationJobRequest req)` 配置迁移服务，配置成功后可通过`CreateMigrationCheckJob` 创建迁移校验任务接口发起校验任务，只有校验通过才能启动迁移任务。
`ModifySyncJobConfigResponse`	`ModifySyncJobConfig(ModifySyncJobConfigRequest req)` 该接口支持在同步任务启动后修改任务的配置修改同步配置的完整流程：修改同步任务配置->创建修改同步任务配置的校验任务->查询修改配置的校验任务的结果->启动修改配置任务
`ModifySyncRateLimitResponse`	`ModifySyncRateLimit(ModifySyncRateLimitRequest req)` 用户在发现同步任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
`PauseMigrateJobResponse`	`PauseMigrateJob(PauseMigrateJobRequest req)` 暂停一个迁移任务。
`PauseSyncJobResponse`	`PauseSyncJob(PauseSyncJobRequest req)` 暂停处于同步中的数据同步任务。
`RecoverMigrateJobResponse`	`RecoverMigrateJob(RecoverMigrateJobRequest req)` 解除隔离数据迁移任务，用户手动发起隔离后的手动解隔离，只有任务状态为已隔离(手动操作)状态下才能触发此操作。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
`RecoverSyncJobResponse`	`RecoverSyncJob(RecoverSyncJobRequest req)` 解除隔离同步任务，任务在已隔离状态下可调用该接口解除隔离状态任务，同时可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。
`ResizeSyncJobResponse`	`ResizeSyncJob(ResizeSyncJobRequest req)` 调整同步任务规格，此接口只支持按量计费任务的调整，调用此接口后不会立即生效，后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs，获取变配后的状态。
`ResumeMigrateJobResponse`	`ResumeMigrateJob(ResumeMigrateJobRequest req)` 重试数据迁移任务，针对异常情况可进行重试，对于redis在失败时也可重试。注意：此操作跳过校验阶段，直接重新发起任务，相当于从StartMigrationJob开始执行。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
`ResumeSyncJobResponse`	`ResumeSyncJob(ResumeSyncJobRequest req)` 重试同步任务，部分可恢复报错情况下，可通过该接口重试同步任务，可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。
`SkipCheckItemResponse`	`SkipCheckItem(SkipCheckItemRequest req)` 本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。
`SkipSyncCheckItemResponse`	`SkipSyncCheckItem(SkipSyncCheckItemRequest req)` 本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。
`StartCompareResponse`	`StartCompare(StartCompareRequest req)` 启动一致性校验任务，启动之前需要先通过接口`CreateCompareTask` 创建一致性校验任务，启动后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态
`StartMigrateJobResponse`	`StartMigrateJob(StartMigrateJobRequest req)` 本接口（StartMigrationJob）用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
`StartModifySyncJobResponse`	`StartModifySyncJob(StartModifySyncJobRequest req)` 在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程
`StartSyncJobResponse`	`StartSyncJob(StartSyncJobRequest req)` 启动同步任务
`StopCompareResponse`	`StopCompare(StopCompareRequest req)` 终止一致性校验任务
`StopMigrateJobResponse`	`StopMigrateJob(StopMigrateJobRequest req)` 本接口（StopMigrateJob）用于终止数据迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
`StopSyncJobResponse`	`StopSyncJob(StopSyncJobRequest req)` 结束同步任务，操作后可通过查询同步任务信息接口DescribeSyncJobs，获取操作后的状态。

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
  - 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
```
    本接口（CompleteMigrateJob）用于完成数据迁移任务。选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。通过DescribeMigrationJobs接口查询到任务的状态为准备完成（Status="readyComplete"）时，此时可以调用本接口完成迁移任务。
    
    Parameters:
    
    req - CompleteMigrateJobRequest
    
    Returns:
    
    CompleteMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ConfigureSyncJob
```
public ConfigureSyncJobResponse ConfigureSyncJob(ConfigureSyncJobRequest req)
                                          throws TencentCloudSDKException
```
    配置一个同步任务
    
    Parameters:
    
    req - ConfigureSyncJobRequest
    
    Returns:
    
    ConfigureSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ContinueMigrateJob
```
public ContinueMigrateJobResponse ContinueMigrateJob(ContinueMigrateJobRequest req)
                                              throws TencentCloudSDKException
```
    恢复一个暂停中的迁移任务。
    
    Parameters:
    
    req - ContinueMigrateJobRequest
    
    Returns:
    
    ContinueMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ContinueSyncJob
```
public ContinueSyncJobResponse ContinueSyncJob(ContinueSyncJobRequest req)
                                        throws TencentCloudSDKException
```
    恢复处于已暂停状态的数据同步任务。
    
    Parameters:
    
    req - ContinueSyncJobRequest
    
    Returns:
    
    ContinueSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCheckSyncJob
```
public CreateCheckSyncJobResponse CreateCheckSyncJob(CreateCheckSyncJobRequest req)
                                              throws TencentCloudSDKException
```
    校验同步任务，检查必要参数和周边配置。
    
    Parameters:
    
    req - CreateCheckSyncJobRequest
    
    Returns:
    
    CreateCheckSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCompareTask
```
public CreateCompareTaskResponse CreateCompareTask(CreateCompareTaskRequest req)
                                            throws TencentCloudSDKException
```
    本接口用于创建数据对比任务，创建成功后会返回数据对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，创建成功后可通过StartCompare启动一致性校验任务
    
    Parameters:
    
    req - CreateCompareTaskRequest
    
    Returns:
    
    CreateCompareTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMigrateCheckJob
```
public CreateMigrateCheckJobResponse CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)
                                                    throws TencentCloudSDKException
```
    校验迁移任务，在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看，校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移
    
    Parameters:
    
    req - CreateMigrateCheckJobRequest
    
    Returns:
    
    CreateMigrateCheckJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMigrationService
```
public CreateMigrationServiceResponse CreateMigrationService(CreateMigrationServiceRequest req)
                                                      throws TencentCloudSDKException
```
    购买迁移任务。购买成功后会返回随机生成的迁移任务id列表，也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意，一旦购买成功后源及目标数据库类型，源及目标实例地域不可修改。
    
    Parameters:
    
    req - CreateMigrationServiceRequest
    
    Returns:
    
    CreateMigrationServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateModifyCheckSyncJob
```
public CreateModifyCheckSyncJobResponse CreateModifyCheckSyncJob(CreateModifyCheckSyncJobRequest req)
                                                          throws TencentCloudSDKException
```
    在修改同步任务的配置后、通过该接口校验当前任务是否支持修改对象操作
    
    Parameters:
    
    req - CreateModifyCheckSyncJobRequest
    
    Returns:
    
    CreateModifyCheckSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSyncJob
```
public CreateSyncJobResponse CreateSyncJob(CreateSyncJobRequest req)
                                    throws TencentCloudSDKException
```
    创建一个同步任务
    
    Parameters:
    
    req - CreateSyncJobRequest
    
    Returns:
    
    CreateSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteCompareTask
```
public DeleteCompareTaskResponse DeleteCompareTask(DeleteCompareTaskRequest req)
                                            throws TencentCloudSDKException
```
    删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。
    
    Parameters:
    
    req - DeleteCompareTaskRequest
    
    Returns:
    
    DeleteCompareTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCheckSyncJobResult
```
public DescribeCheckSyncJobResultResponse DescribeCheckSyncJobResult(DescribeCheckSyncJobResultRequest req)
                                                              throws TencentCloudSDKException
```
    查询同步校验任务结果，检查必要参数和周边配置
    
    Parameters:
    
    req - DescribeCheckSyncJobResultRequest
    
    Returns:
    
    DescribeCheckSyncJobResultResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCompareReport
```
public DescribeCompareReportResponse DescribeCompareReport(DescribeCompareReportRequest req)
                                                    throws TencentCloudSDKException
```
    查询一致性校验任务详情
    
    Parameters:
    
    req - DescribeCompareReportRequest
    
    Returns:
    
    DescribeCompareReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCompareTasks
```
public DescribeCompareTasksResponse DescribeCompareTasks(DescribeCompareTasksRequest req)
                                                  throws TencentCloudSDKException
```
    查询一致性校验任务列表，调用该接口后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态。
    
    Parameters:
    
    req - DescribeCompareTasksRequest
    
    Returns:
    
    DescribeCompareTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMigrateDBInstances
```
public DescribeMigrateDBInstancesResponse DescribeMigrateDBInstances(DescribeMigrateDBInstancesRequest req)
                                                              throws TencentCloudSDKException
```
    本接口用于查询支持迁移的云数据库实例
    
    Parameters:
    
    req - DescribeMigrateDBInstancesRequest
    
    Returns:
    
    DescribeMigrateDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMigrationCheckJob
```
public DescribeMigrationCheckJobResponse DescribeMigrationCheckJob(DescribeMigrationCheckJobRequest req)
                                                            throws TencentCloudSDKException
```
    本接口用于创建校验后,获取校验的结果. 能查询到当前校验的状态和进度. 若通过校验, 则可调用'StartMigrateJob' 开始迁移. 若未通过校验, 则能查询到校验失败的原因. 请按照报错, 通过'ModifyMigrationJob'修改迁移配置或是调整源/目标实例的相关参数.
    
    Parameters:
    
    req - DescribeMigrationCheckJobRequest
    
    Returns:
    
    DescribeMigrationCheckJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMigrationDetail
```
public DescribeMigrationDetailResponse DescribeMigrationDetail(DescribeMigrationDetailRequest req)
                                                        throws TencentCloudSDKException
```
    查询某个迁移任务详情
    
    Parameters:
    
    req - DescribeMigrationDetailRequest
    
    Returns:
    
    DescribeMigrationDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMigrationJobs
```
public DescribeMigrationJobsResponse DescribeMigrationJobs(DescribeMigrationJobsRequest req)
                                                    throws TencentCloudSDKException
```
    查询数据迁移任务列表
    
    Parameters:
    
    req - DescribeMigrationJobsRequest
    
    Returns:
    
    DescribeMigrationJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeModifyCheckSyncJobResult
```
public DescribeModifyCheckSyncJobResultResponse DescribeModifyCheckSyncJobResult(DescribeModifyCheckSyncJobResultRequest req)
                                                                          throws TencentCloudSDKException
```
    在创建修改对象的校验任务后、通过该接口查看校验任务的结果
    
    Parameters:
    
    req - DescribeModifyCheckSyncJobResultRequest
    
    Returns:
    
    DescribeModifyCheckSyncJobResultResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSyncJobs
```
public DescribeSyncJobsResponse DescribeSyncJobs(DescribeSyncJobsRequest req)
                                          throws TencentCloudSDKException
```
    查询同步任务信息
    
    Parameters:
    
    req - DescribeSyncJobsRequest
    
    Returns:
    
    DescribeSyncJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DestroyMigrateJob
```
public DestroyMigrateJobResponse DestroyMigrateJob(DestroyMigrateJobRequest req)
                                            throws TencentCloudSDKException
```
    下线数据迁移任务。计费任务必须先调用隔离(IsolateMigrateJob)接口，且只有是**已隔离**状态下，才能调用此接口销毁任务。对于不计费任务，调用隔离(IsolateMigrateJob)接口删除任务操作。
    
    Parameters:
    
    req - DestroyMigrateJobRequest
    
    Returns:
    
    DestroyMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DestroySyncJob
```
public DestroySyncJobResponse DestroySyncJob(DestroySyncJobRequest req)
                                      throws TencentCloudSDKException
```
    下线同步任务，任务在已隔离状态下可以通过此操作进行任务下线，即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态，此操作成功后无法看到此任务表示下线成功。
    
    Parameters:
    
    req - DestroySyncJobRequest
    
    Returns:
    
    DestroySyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateMigrateJob
```
public IsolateMigrateJobResponse IsolateMigrateJob(IsolateMigrateJobRequest req)
                                            throws TencentCloudSDKException
```
    隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务，在任务隔离后可进行解除隔离(RecoverMigrationJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务，调用此接口会直接销毁任务，无法进行恢复操作。
    
    Parameters:
    
    req - IsolateMigrateJobRequest
    
    Returns:
    
    IsolateMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateSyncJob
```
public IsolateSyncJobResponse IsolateSyncJob(IsolateSyncJobRequest req)
                                      throws TencentCloudSDKException
```
    隔离同步任务，隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务，调用此接口后会直接删除任务，无法进行恢复操作。
    
    Parameters:
    
    req - IsolateSyncJobRequest
    
    Returns:
    
    IsolateSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyCompareTask
```
public ModifyCompareTaskResponse ModifyCompareTask(ModifyCompareTaskRequest req)
                                            throws TencentCloudSDKException
```
    修改一致性校验任务，在任务创建后启动之前，可修改一致性校验参数
    
    Parameters:
    
    req - ModifyCompareTaskRequest
    
    Returns:
    
    ModifyCompareTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyCompareTaskName
```
public ModifyCompareTaskNameResponse ModifyCompareTaskName(ModifyCompareTaskNameRequest req)
                                                    throws TencentCloudSDKException
```
    修改一致性校验任务名称
    
    Parameters:
    
    req - ModifyCompareTaskNameRequest
    
    Returns:
    
    ModifyCompareTaskNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMigrateJobSpec
```
public ModifyMigrateJobSpecResponse ModifyMigrateJobSpec(ModifyMigrateJobSpecRequest req)
                                                  throws TencentCloudSDKException
```
    调整实例规格，此接口只支持按量计费任务的调整。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
    
    Parameters:
    
    req - ModifyMigrateJobSpecRequest
    
    Returns:
    
    ModifyMigrateJobSpecResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMigrateName
```
public ModifyMigrateNameResponse ModifyMigrateName(ModifyMigrateNameRequest req)
                                            throws TencentCloudSDKException
```
    修改迁移任务名
    
    Parameters:
    
    req - ModifyMigrateNameRequest
    
    Returns:
    
    ModifyMigrateNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMigrateRateLimit
```
public ModifyMigrateRateLimitResponse ModifyMigrateRateLimit(ModifyMigrateRateLimitRequest req)
                                                      throws TencentCloudSDKException
```
    用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
    
    Parameters:
    
    req - ModifyMigrateRateLimitRequest
    
    Returns:
    
    ModifyMigrateRateLimitResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMigrateRuntimeAttribute
```
public ModifyMigrateRuntimeAttributeResponse ModifyMigrateRuntimeAttribute(ModifyMigrateRuntimeAttributeRequest req)
                                                                    throws TencentCloudSDKException
```
    修改任务运行时属性，此接口不同于配置类接口，不会进行状态机判断。
    
    Parameters:
    
    req - ModifyMigrateRuntimeAttributeRequest
    
    Returns:
    
    ModifyMigrateRuntimeAttributeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMigrationJob
```
public ModifyMigrationJobResponse ModifyMigrationJob(ModifyMigrationJobRequest req)
                                              throws TencentCloudSDKException
```
    配置迁移服务，配置成功后可通过`CreateMigrationCheckJob` 创建迁移校验任务接口发起校验任务，只有校验通过才能启动迁移任务。
    
    Parameters:
    
    req - ModifyMigrationJobRequest
    
    Returns:
    
    ModifyMigrationJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySyncJobConfig
```
public ModifySyncJobConfigResponse ModifySyncJobConfig(ModifySyncJobConfigRequest req)
                                                throws TencentCloudSDKException
```
    该接口支持在同步任务启动后修改任务的配置修改同步配置的完整流程：修改同步任务配置->创建修改同步任务配置的校验任务->查询修改配置的校验任务的结果->启动修改配置任务
    
    Parameters:
    
    req - ModifySyncJobConfigRequest
    
    Returns:
    
    ModifySyncJobConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySyncRateLimit
```
public ModifySyncRateLimitResponse ModifySyncRateLimit(ModifySyncRateLimitRequest req)
                                                throws TencentCloudSDKException
```
    用户在发现同步任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
    
    Parameters:
    
    req - ModifySyncRateLimitRequest
    
    Returns:
    
    ModifySyncRateLimitResponse
    
    Throws:
    
    TencentCloudSDKException
  - PauseMigrateJob
```
public PauseMigrateJobResponse PauseMigrateJob(PauseMigrateJobRequest req)
                                        throws TencentCloudSDKException
```
    暂停一个迁移任务。
    
    Parameters:
    
    req - PauseMigrateJobRequest
    
    Returns:
    
    PauseMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - PauseSyncJob
```
public PauseSyncJobResponse PauseSyncJob(PauseSyncJobRequest req)
                                  throws TencentCloudSDKException
```
    暂停处于同步中的数据同步任务。
    
    Parameters:
    
    req - PauseSyncJobRequest
    
    Returns:
    
    PauseSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - RecoverMigrateJob
```
public RecoverMigrateJobResponse RecoverMigrateJob(RecoverMigrateJobRequest req)
                                            throws TencentCloudSDKException
```
    解除隔离数据迁移任务，用户手动发起隔离后的手动解隔离，只有任务状态为已隔离(手动操作)状态下才能触发此操作。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
    
    Parameters:
    
    req - RecoverMigrateJobRequest
    
    Returns:
    
    RecoverMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - RecoverSyncJob
```
public RecoverSyncJobResponse RecoverSyncJob(RecoverSyncJobRequest req)
                                      throws TencentCloudSDKException
```
    解除隔离同步任务，任务在已隔离状态下可调用该接口解除隔离状态任务，同时可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。
    
    Parameters:
    
    req - RecoverSyncJobRequest
    
    Returns:
    
    RecoverSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResizeSyncJob
```
public ResizeSyncJobResponse ResizeSyncJob(ResizeSyncJobRequest req)
                                    throws TencentCloudSDKException
```
    调整同步任务规格，此接口只支持按量计费任务的调整，调用此接口后不会立即生效，后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs，获取变配后的状态。
    
    Parameters:
    
    req - ResizeSyncJobRequest
    
    Returns:
    
    ResizeSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResumeMigrateJob
```
public ResumeMigrateJobResponse ResumeMigrateJob(ResumeMigrateJobRequest req)
                                          throws TencentCloudSDKException
```
    重试数据迁移任务，针对异常情况可进行重试，对于redis在失败时也可重试。注意：此操作跳过校验阶段，直接重新发起任务，相当于从StartMigrationJob开始执行。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
    
    Parameters:
    
    req - ResumeMigrateJobRequest
    
    Returns:
    
    ResumeMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResumeSyncJob
```
public ResumeSyncJobResponse ResumeSyncJob(ResumeSyncJobRequest req)
                                    throws TencentCloudSDKException
```
    重试同步任务，部分可恢复报错情况下，可通过该接口重试同步任务，可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。
    
    Parameters:
    
    req - ResumeSyncJobRequest
    
    Returns:
    
    ResumeSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - SkipCheckItem
```
public SkipCheckItemResponse SkipCheckItem(SkipCheckItemRequest req)
                                    throws TencentCloudSDKException
```
    本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。
    
    Parameters:
    
    req - SkipCheckItemRequest
    
    Returns:
    
    SkipCheckItemResponse
    
    Throws:
    
    TencentCloudSDKException
  - SkipSyncCheckItem
```
public SkipSyncCheckItemResponse SkipSyncCheckItem(SkipSyncCheckItemRequest req)
                                            throws TencentCloudSDKException
```
    本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。
    
    Parameters:
    
    req - SkipSyncCheckItemRequest
    
    Returns:
    
    SkipSyncCheckItemResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartCompare
```
public StartCompareResponse StartCompare(StartCompareRequest req)
                                  throws TencentCloudSDKException
```
    启动一致性校验任务，启动之前需要先通过接口`CreateCompareTask` 创建一致性校验任务，启动后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态
    
    Parameters:
    
    req - StartCompareRequest
    
    Returns:
    
    StartCompareResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartMigrateJob
```
public StartMigrateJobResponse StartMigrateJob(StartMigrateJobRequest req)
                                        throws TencentCloudSDKException
```
    本接口（StartMigrationJob）用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
    
    Parameters:
    
    req - StartMigrateJobRequest
    
    Returns:
    
    StartMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartModifySyncJob
```
public StartModifySyncJobResponse StartModifySyncJob(StartModifySyncJobRequest req)
                                              throws TencentCloudSDKException
```
    在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程
    
    Parameters:
    
    req - StartModifySyncJobRequest
    
    Returns:
    
    StartModifySyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartSyncJob
```
public StartSyncJobResponse StartSyncJob(StartSyncJobRequest req)
                                  throws TencentCloudSDKException
```
    启动同步任务
    
    Parameters:
    
    req - StartSyncJobRequest
    
    Returns:
    
    StartSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopCompare
```
public StopCompareResponse StopCompare(StopCompareRequest req)
                                throws TencentCloudSDKException
```
    终止一致性校验任务
    
    Parameters:
    
    req - StopCompareRequest
    
    Returns:
    
    StopCompareResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopMigrateJob
```
public StopMigrateJobResponse StopMigrateJob(StopMigrateJobRequest req)
                                      throws TencentCloudSDKException
```
    本接口（StopMigrateJob）用于终止数据迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
    
    Parameters:
    
    req - StopMigrateJobRequest
    
    Returns:
    
    StopMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopSyncJob
```
public StopSyncJobResponse StopSyncJob(StopSyncJobRequest req)
                                throws TencentCloudSDKException
```
    结束同步任务，操作后可通过查询同步任务信息接口DescribeSyncJobs，获取操作后的状态。
    
    Parameters:
    
    req - StopSyncJobRequest
    
    Returns:
    
    StopSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException

Class DtsClient

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

DtsClient

DtsClient

Method Detail

CompleteMigrateJob

ConfigureSyncJob

ContinueMigrateJob

ContinueSyncJob

CreateCheckSyncJob

CreateCompareTask

CreateMigrateCheckJob

CreateMigrationService

CreateModifyCheckSyncJob

CreateSyncJob

DeleteCompareTask

DescribeCheckSyncJobResult

DescribeCompareReport

DescribeCompareTasks

DescribeMigrateDBInstances

DescribeMigrationCheckJob

DescribeMigrationDetail

DescribeMigrationJobs

DescribeModifyCheckSyncJobResult

DescribeSyncJobs

DestroyMigrateJob

DestroySyncJob

IsolateMigrateJob

IsolateSyncJob

ModifyCompareTask

ModifyCompareTaskName

ModifyMigrateJobSpec

ModifyMigrateName

ModifyMigrateRateLimit

ModifyMigrateRuntimeAttribute

ModifyMigrationJob

ModifySyncJobConfig

ModifySyncRateLimit

PauseMigrateJob

PauseSyncJob

RecoverMigrateJob

RecoverSyncJob

ResizeSyncJob

ResumeMigrateJob

ResumeSyncJob

SkipCheckItem

SkipSyncCheckItem

StartCompare

StartMigrateJob

StartModifySyncJob

StartSyncJob

StopCompare

StopMigrateJob

StopSyncJob