DtsClient (tencentcloud-sdk-java 3.0.93 API)

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)` 构造client
`DtsClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompleteMigrateJobResponse`	`CompleteMigrateJob(CompleteMigrateJobRequest req)` 本接口（CompleteMigrateJob）用于完成数据迁移任务。选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。通过DescribeMigrateJobs接口查询到任务的状态为准备完成（status=8）时，此时可以调用本接口完成迁移任务。
`CreateMigrateCheckJobResponse`	`CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)` 创建校验迁移任务在开始迁移前, 必须调用本接口创建校验, 且校验成功后才能开始迁移.
`CreateMigrateJobResponse`	`CreateMigrateJob(CreateMigrateJobRequest req)` 本接口（CreateMigrateJob）用于创建数据迁移任务。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
`CreateSyncCheckJobResponse`	`CreateSyncCheckJob(CreateSyncCheckJobRequest req)` 在调用 StartSyncJob 接口启动灾备同步前, 必须调用本接口创建校验, 且校验成功后才能开始同步数据.
`CreateSyncJobResponse`	`CreateSyncJob(CreateSyncJobRequest req)` 本接口(CreateSyncJob)用于创建灾备同步任务。创建同步任务后，可以通过 CreateSyncCheckJob 接口发起校验任务。校验成功后才可以通过 StartSyncJob 接口启动同步任务。
`DeleteMigrateJobResponse`	`DeleteMigrateJob(DeleteMigrateJobRequest req)` 本接口（DeleteMigrationJob）用于删除数据迁移任务。当通过DescribeMigrateJobs接口查询到任务的状态为：检验中（status=3）、运行中（status=7）、准备完成（status=8）、撤销中（status=11）或者完成中（status=12）时，不允许删除任务。
`DeleteSyncJobResponse`	`DeleteSyncJob(DeleteSyncJobRequest req)` 删除灾备同步任务（运行中的同步任务不能删除）。
`DescribeMigrateCheckJobResponse`	`DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req)` 本接口用于创建校验后,获取校验的结果.
`DescribeMigrateJobsResponse`	`DescribeMigrateJobs(DescribeMigrateJobsRequest req)` 查询数据迁移任务.
`DescribeSyncCheckJobResponse`	`DescribeSyncCheckJob(DescribeSyncCheckJobRequest req)` 本接口用于在通过 CreateSyncCheckJob 接口创建灾备同步校验任务后，获取校验的结果。能查询到当前校验的状态和进度。若通过校验, 则可调用 StartSyncJob 启动同步任务。若未通过校验, 则会返回校验失败的原因。可通过 ModifySyncJob 修改配置，然后再次发起校验。校验任务需要大概约30秒，当返回的 Status 不为 finished 时表示尚未校验完成，需要轮询该接口。如果 Status=finished 且 CheckFlag=1 时表示校验成功。如果 Status=finished 且 CheckFlag !=1 时表示校验失败。
`DescribeSyncJobsResponse`	`DescribeSyncJobs(DescribeSyncJobsRequest req)` 查询在迁移平台发起的灾备同步任务
`ModifyMigrateJobResponse`	`ModifyMigrateJob(ModifyMigrateJobRequest req)` 本接口（ModifyMigrateJob）用于修改数据迁移任务。当迁移任务处于下述状态时，允许调用本接口修改迁移任务：迁移创建中（status=1）、校验成功(status=4)、校验失败(status=5)、迁移失败(status=10)。但源实例、目标实例类型和目标实例地域不允许修改。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
`ModifySyncJobResponse`	`ModifySyncJob(ModifySyncJobRequest req)` 修改灾备同步任务.
`StartMigrateJobResponse`	`StartMigrateJob(StartMigrateJobRequest req)` 本接口（StartMigrationJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。调用此接口前，请务必先使用CreateMigrateCheckJob校验数据迁移任务，并通过DescribeMigrateJobs接口查询到任务状态为校验通过（status=4）时，才能启动数据迁移任务。
`StartSyncJobResponse`	`StartSyncJob(StartSyncJobRequest req)` 创建的灾备同步任务在通过 CreateSyncCheckJob 和 DescribeSyncCheckJob 确定校验成功后，可以调用该接口启动同步
`StopMigrateJobResponse`	`StopMigrateJob(StopMigrateJobRequest req)` 本接口（StopMigrateJob）用于撤销数据迁移任务。在迁移过程中允许调用该接口撤销迁移, 撤销迁移的任务会失败。通过DescribeMigrateJobs接口查询到任务状态为运行中（status=7）或准备完成（status=8）时，才能撤销数据迁移任务。
`SwitchDrToMasterResponse`	`SwitchDrToMaster(SwitchDrToMasterRequest req)` 将灾备升级为主实例，停止从原来所属主实例的同步，断开主备关系。

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)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - DtsClient
```
public DtsClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - CompleteMigrateJob
```
public CompleteMigrateJobResponse CompleteMigrateJob(CompleteMigrateJobRequest req)
                                              throws TencentCloudSDKException
```
    本接口（CompleteMigrateJob）用于完成数据迁移任务。选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。通过DescribeMigrateJobs接口查询到任务的状态为准备完成（status=8）时，此时可以调用本接口完成迁移任务。
    
    Parameters:
    
    req - CompleteMigrateJobRequest
    
    Returns:
    
    CompleteMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMigrateCheckJob
```
public CreateMigrateCheckJobResponse CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)
                                                    throws TencentCloudSDKException
```
    创建校验迁移任务在开始迁移前, 必须调用本接口创建校验, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrateCheckJob查看. 校验成功后,迁移任务若有修改, 则必须重新创建校验并通过后, 才能开始迁移.
    
    Parameters:
    
    req - CreateMigrateCheckJobRequest
    
    Returns:
    
    CreateMigrateCheckJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMigrateJob
```
public CreateMigrateJobResponse CreateMigrateJob(CreateMigrateJobRequest req)
                                          throws TencentCloudSDKException
```
    本接口（CreateMigrateJob）用于创建数据迁移任务。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
    
    Parameters:
    
    req - CreateMigrateJobRequest
    
    Returns:
    
    CreateMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSyncCheckJob
```
public CreateSyncCheckJobResponse CreateSyncCheckJob(CreateSyncCheckJobRequest req)
                                              throws TencentCloudSDKException
```
    在调用 StartSyncJob 接口启动灾备同步前, 必须调用本接口创建校验, 且校验成功后才能开始同步数据. 校验的结果可以通过 DescribeSyncCheckJob 查看. 校验成功后才能启动同步.
    
    Parameters:
    
    req - CreateSyncCheckJobRequest
    
    Returns:
    
    CreateSyncCheckJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSyncJob
```
public CreateSyncJobResponse CreateSyncJob(CreateSyncJobRequest req)
                                    throws TencentCloudSDKException
```
    本接口(CreateSyncJob)用于创建灾备同步任务。创建同步任务后，可以通过 CreateSyncCheckJob 接口发起校验任务。校验成功后才可以通过 StartSyncJob 接口启动同步任务。
    
    Parameters:
    
    req - CreateSyncJobRequest
    
    Returns:
    
    CreateSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteMigrateJob
```
public DeleteMigrateJobResponse DeleteMigrateJob(DeleteMigrateJobRequest req)
                                          throws TencentCloudSDKException
```
    本接口（DeleteMigrationJob）用于删除数据迁移任务。当通过DescribeMigrateJobs接口查询到任务的状态为：检验中（status=3）、运行中（status=7）、准备完成（status=8）、撤销中（status=11）或者完成中（status=12）时，不允许删除任务。
    
    Parameters:
    
    req - DeleteMigrateJobRequest
    
    Returns:
    
    DeleteMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteSyncJob
```
public DeleteSyncJobResponse DeleteSyncJob(DeleteSyncJobRequest req)
                                    throws TencentCloudSDKException
```
    删除灾备同步任务（运行中的同步任务不能删除）。
    
    Parameters:
    
    req - DeleteSyncJobRequest
    
    Returns:
    
    DeleteSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMigrateCheckJob
```
public DescribeMigrateCheckJobResponse DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req)
                                                        throws TencentCloudSDKException
```
    本接口用于创建校验后,获取校验的结果. 能查询到当前校验的状态和进度. 若通过校验, 则可调用'StartMigrateJob' 开始迁移. 若未通过校验, 则能查询到校验失败的原因. 请按照报错, 通过'ModifyMigrateJob'修改迁移配置或是调整源/目标实例的相关参数.
    
    Parameters:
    
    req - DescribeMigrateCheckJobRequest
    
    Returns:
    
    DescribeMigrateCheckJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMigrateJobs
```
public DescribeMigrateJobsResponse DescribeMigrateJobs(DescribeMigrateJobsRequest req)
                                                throws TencentCloudSDKException
```
    查询数据迁移任务. 如果是金融区链路, 请使用域名: https://dts.ap-shenzhen-fsi.tencentcloudapi.com
    
    Parameters:
    
    req - DescribeMigrateJobsRequest
    
    Returns:
    
    DescribeMigrateJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSyncCheckJob
```
public DescribeSyncCheckJobResponse DescribeSyncCheckJob(DescribeSyncCheckJobRequest req)
                                                  throws TencentCloudSDKException
```
    本接口用于在通过 CreateSyncCheckJob 接口创建灾备同步校验任务后，获取校验的结果。能查询到当前校验的状态和进度。若通过校验, 则可调用 StartSyncJob 启动同步任务。若未通过校验, 则会返回校验失败的原因。可通过 ModifySyncJob 修改配置，然后再次发起校验。校验任务需要大概约30秒，当返回的 Status 不为 finished 时表示尚未校验完成，需要轮询该接口。如果 Status=finished 且 CheckFlag=1 时表示校验成功。如果 Status=finished 且 CheckFlag !=1 时表示校验失败。
    
    Parameters:
    
    req - DescribeSyncCheckJobRequest
    
    Returns:
    
    DescribeSyncCheckJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSyncJobs
```
public DescribeSyncJobsResponse DescribeSyncJobs(DescribeSyncJobsRequest req)
                                          throws TencentCloudSDKException
```
    查询在迁移平台发起的灾备同步任务
    
    Parameters:
    
    req - DescribeSyncJobsRequest
    
    Returns:
    
    DescribeSyncJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMigrateJob
```
public ModifyMigrateJobResponse ModifyMigrateJob(ModifyMigrateJobRequest req)
                                          throws TencentCloudSDKException
```
    本接口（ModifyMigrateJob）用于修改数据迁移任务。当迁移任务处于下述状态时，允许调用本接口修改迁移任务：迁移创建中（status=1）、校验成功(status=4)、校验失败(status=5)、迁移失败(status=10)。但源实例、目标实例类型和目标实例地域不允许修改。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
    
    Parameters:
    
    req - ModifyMigrateJobRequest
    
    Returns:
    
    ModifyMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySyncJob
```
public ModifySyncJobResponse ModifySyncJob(ModifySyncJobRequest req)
                                    throws TencentCloudSDKException
```
    修改灾备同步任务. 当同步任务处于下述状态时, 允许调用本接口: 同步任务创建中, 创建完成, 校验成功, 校验失败. 源实例和目标实例信息不允许修改，可以修改任务名、需要同步的库表。
    
    Parameters:
    
    req - ModifySyncJobRequest
    
    Returns:
    
    ModifySyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartMigrateJob
```
public StartMigrateJobResponse StartMigrateJob(StartMigrateJobRequest req)
                                        throws TencentCloudSDKException
```
    本接口（StartMigrationJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。调用此接口前，请务必先使用CreateMigrateCheckJob校验数据迁移任务，并通过DescribeMigrateJobs接口查询到任务状态为校验通过（status=4）时，才能启动数据迁移任务。
    
    Parameters:
    
    req - StartMigrateJobRequest
    
    Returns:
    
    StartMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartSyncJob
```
public StartSyncJobResponse StartSyncJob(StartSyncJobRequest req)
                                  throws TencentCloudSDKException
```
    创建的灾备同步任务在通过 CreateSyncCheckJob 和 DescribeSyncCheckJob 确定校验成功后，可以调用该接口启动同步
    
    Parameters:
    
    req - StartSyncJobRequest
    
    Returns:
    
    StartSyncJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopMigrateJob
```
public StopMigrateJobResponse StopMigrateJob(StopMigrateJobRequest req)
                                      throws TencentCloudSDKException
```
    本接口（StopMigrateJob）用于撤销数据迁移任务。在迁移过程中允许调用该接口撤销迁移, 撤销迁移的任务会失败。通过DescribeMigrateJobs接口查询到任务状态为运行中（status=7）或准备完成（status=8）时，才能撤销数据迁移任务。
    
    Parameters:
    
    req - StopMigrateJobRequest
    
    Returns:
    
    StopMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - SwitchDrToMaster
```
public SwitchDrToMasterResponse SwitchDrToMaster(SwitchDrToMasterRequest req)
                                          throws TencentCloudSDKException
```
    将灾备升级为主实例，停止从原来所属主实例的同步，断开主备关系。
    
    Parameters:
    
    req - SwitchDrToMasterRequest
    
    Returns:
    
    SwitchDrToMasterResponse
    
    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

CreateMigrateCheckJob

CreateMigrateJob

CreateSyncCheckJob

CreateSyncJob

DeleteMigrateJob

DeleteSyncJob

DescribeMigrateCheckJob

DescribeMigrateJobs

DescribeSyncCheckJob

DescribeSyncJobs

ModifyMigrateJob

ModifySyncJob

StartMigrateJob

StartSyncJob

StopMigrateJob

SwitchDrToMaster