DtsClient (tencentcloud-sdk-java 3.0.13 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)` 完成数据迁移任务.
`CreateMigrateCheckJobResponse`	`CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)` 创建校验迁移任务在开始迁移前, 必须调用本接口创建校验, 且校验成功后才能开始迁移.
`CreateMigrateJobResponse`	`CreateMigrateJob(CreateMigrateJobRequest req)` 本接口用于创建数据迁移任务。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
`DeleteMigrateJobResponse`	`DeleteMigrateJob(DeleteMigrateJobRequest req)` 删除数据迁移任务.
`DescribeMigrateCheckJobResponse`	`DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req)` 本接口用于创建校验后,获取校验的结果.
`DescribeMigrateJobsResponse`	`DescribeMigrateJobs(DescribeMigrateJobsRequest req)` 查询数据迁移任务.
`ModifyMigrateJobResponse`	`ModifyMigrateJob(ModifyMigrateJobRequest req)` 修改数据迁移任务.
`StartMigrateJobResponse`	`StartMigrateJob(StartMigrateJobRequest req)` 非定时任务会在调用后立即开始迁移，定时任务则会开始倒计时。调用此接口前，请务必先校验数据迁移任务通过。
`StopMigrateJobResponse`	`StopMigrateJob(StopMigrateJobRequest req)` 撤销数据迁移任务.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
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
```
    完成数据迁移任务. 选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据. 只有当正在迁移的任务, 进入了准备完成阶段, 才能调用本接口完成迁移.
    
    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
```
    本接口用于创建数据迁移任务。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
    
    Parameters:
    
    req - CreateMigrateJobRequest
    
    Returns:
    
    CreateMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteMigrateJob
```
public DeleteMigrateJobResponse DeleteMigrateJob(DeleteMigrateJobRequest req)
                                          throws TencentCloudSDKException
```
    删除数据迁移任务. 正在校验和正在迁移的任务不允许删除
    
    Parameters:
    
    req - DeleteMigrateJobRequest
    
    Returns:
    
    DeleteMigrateJobResponse
    
    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
  - ModifyMigrateJob
```
public ModifyMigrateJobResponse ModifyMigrateJob(ModifyMigrateJobRequest req)
                                          throws TencentCloudSDKException
```
    修改数据迁移任务. 当迁移任务处于下述状态时, 允许调用本接口: 迁移创建中, 创建完成, 校验成功, 校验失败, 迁移失败. 源实例和目标实例类型不允许修改, 目标实例地域不允许修改。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
    
    Parameters:
    
    req - ModifyMigrateJobRequest
    
    Returns:
    
    ModifyMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartMigrateJob
```
public StartMigrateJobResponse StartMigrateJob(StartMigrateJobRequest req)
                                        throws TencentCloudSDKException
```
    非定时任务会在调用后立即开始迁移，定时任务则会开始倒计时。调用此接口前，请务必先校验数据迁移任务通过。
    
    Parameters:
    
    req - StartMigrateJobRequest
    
    Returns:
    
    StartMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopMigrateJob
```
public StopMigrateJobResponse StopMigrateJob(StopMigrateJobRequest req)
                                      throws TencentCloudSDKException
```
    撤销数据迁移任务. 在迁移过程中允许调用该接口撤销迁移, 撤销迁移的任务会失败.
    
    Parameters:
    
    req - StopMigrateJobRequest
    
    Returns:
    
    StopMigrateJobResponse
    
    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

DeleteMigrateJob

DescribeMigrateCheckJob

DescribeMigrateJobs

ModifyMigrateJob

StartMigrateJob

StopMigrateJob