DtsClient (tencentcloud-sdk-java 3.1.650 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)`
`DtsClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActivateSubscribeResponse`	`ActivateSubscribe(ActivateSubscribeRequest req)` 本接口用于配置数据订阅，只有在未配置状态的订阅实例才能调用此接口。
`CompleteMigrateJobResponse`	`CompleteMigrateJob(CompleteMigrateJobRequest req)` 本接口（CompleteMigrateJob）用于完成数据迁移任务。选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。通过DescribeMigrateJobs接口查询到任务的状态为准备完成（status=8）时，此时可以调用本接口完成迁移任务。
`CreateMigrateCheckJobResponse`	`CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)` 创建校验迁移任务在开始迁移前, 必须调用本接口创建校验, 且校验成功后才能开始迁移.
`CreateMigrateJobResponse`	`CreateMigrateJob(CreateMigrateJobRequest req)` 本接口（CreateMigrateJob）用于创建数据迁移任务。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
`CreateSubscribeResponse`	`CreateSubscribe(CreateSubscribeRequest req)` 本接口(CreateSubscribe)用于创建一个数据订阅实例。
`DeleteMigrateJobResponse`	`DeleteMigrateJob(DeleteMigrateJobRequest req)` 本接口（DeleteMigrationJob）用于删除数据迁移任务。当通过DescribeMigrateJobs接口查询到任务的状态为：检验中（status=3）、运行中（status=7）、准备完成（status=8）、撤销中（status=11）或者完成中（status=12）时，不允许删除任务。
`DescribeAsyncRequestInfoResponse`	`DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)` 本接口（DescribeAsyncRequestInfo）用于查询任务执行结果
`DescribeMigrateCheckJobResponse`	`DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req)` 本接口用于创建校验后,获取校验的结果.
`DescribeMigrateJobsResponse`	`DescribeMigrateJobs(DescribeMigrateJobsRequest req)` 查询数据迁移任务.
`DescribeRegionConfResponse`	`DescribeRegionConf(DescribeRegionConfRequest req)` 本接口（DescribeRegionConf）用于查询可售卖订阅实例的地域
`DescribeSubscribeConfResponse`	`DescribeSubscribeConf(DescribeSubscribeConfRequest req)` 本接口（DescribeSubscribeConf）用于查询订阅实例配置
`DescribeSubscribesResponse`	`DescribeSubscribes(DescribeSubscribesRequest req)` 本接口(DescribeSubscribes)获取数据订阅实例信息列表，默认分页，每次返回20条
`IsolateSubscribeResponse`	`IsolateSubscribe(IsolateSubscribeRequest req)` 本接口（IsolateSubscribe）用于隔离小时计费的订阅实例。调用后，订阅实例将不能使用，同时停止计费。
`ModifyMigrateJobResponse`	`ModifyMigrateJob(ModifyMigrateJobRequest req)` 本接口（ModifyMigrateJob）用于修改数据迁移任务。当迁移任务处于下述状态时，允许调用本接口修改迁移任务：迁移创建中（status=1）、校验成功(status=4)、校验失败(status=5)、迁移失败(status=10)。但源实例、目标实例类型和目标实例地域不允许修改。如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
`ModifySubscribeAutoRenewFlagResponse`	`ModifySubscribeAutoRenewFlag(ModifySubscribeAutoRenewFlagRequest req)` 修改订阅实例自动续费标识
`ModifySubscribeConsumeTimeResponse`	`ModifySubscribeConsumeTime(ModifySubscribeConsumeTimeRequest req)` 本接口(ModifySubscribeConsumeTime)用于修改数据订阅通道的消费时间点
`ModifySubscribeNameResponse`	`ModifySubscribeName(ModifySubscribeNameRequest req)` 本接口(ModifySubscribeName)用于修改数据订阅实例的名称
`ModifySubscribeObjectsResponse`	`ModifySubscribeObjects(ModifySubscribeObjectsRequest req)` 本接口(ModifySubscribeObjects)用于修改数据订阅通道的订阅规则
`ModifySubscribeVipVportResponse`	`ModifySubscribeVipVport(ModifySubscribeVipVportRequest req)` 本接口(ModifySubscribeVipVport)用于修改数据订阅实例的IP和端口号
`OfflineIsolatedSubscribeResponse`	`OfflineIsolatedSubscribe(OfflineIsolatedSubscribeRequest req)` 本接口（OfflineIsolatedSubscribe）用于下线已隔离的数据订阅实例
`ResetSubscribeResponse`	`ResetSubscribe(ResetSubscribeRequest req)` 本接口(ResetSubscribe)用于重置数据订阅实例，已经激活的数据订阅实例，重置后可以使用ActivateSubscribe接口绑定其他的数据库实例
`StartMigrateJobResponse`	`StartMigrateJob(StartMigrateJobRequest req)` 本接口（StartMigrationJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。调用此接口前，请务必先使用CreateMigrateCheckJob校验数据迁移任务，并通过DescribeMigrateJobs接口查询到任务状态为校验通过（status=4）时，才能启动数据迁移任务。
`StopMigrateJobResponse`	`StopMigrateJob(StopMigrateJobRequest req)` 本接口（StopMigrateJob）用于撤销数据迁移任务。在迁移过程中允许调用该接口撤销迁移, 撤销迁移的任务会失败。通过DescribeMigrateJobs接口查询到任务状态为运行中（status=7）或准备完成（status=8）时，才能撤销数据迁移任务。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, 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
```
    本接口用于配置数据订阅，只有在未配置状态的订阅实例才能调用此接口。
    
    Parameters:
    
    req - ActivateSubscribeRequest
    
    Returns:
    
    ActivateSubscribeResponse
    
    Throws:
    
    TencentCloudSDKException
  - 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查看. 校验成功后,迁移任务若有修改, 则必须重新创建校验并通过后, 才能开始迁移. 如果是金融区链路, 请使用域名: https://dts.ap-shenzhen-fsi.tencentcloudapi.com
    
    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
  - CreateSubscribe
```
public CreateSubscribeResponse CreateSubscribe(CreateSubscribeRequest req)
                                        throws TencentCloudSDKException
```
    本接口(CreateSubscribe)用于创建一个数据订阅实例。
    
    Parameters:
    
    req - CreateSubscribeRequest
    
    Returns:
    
    CreateSubscribeResponse
    
    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
  - DescribeAsyncRequestInfo
```
public DescribeAsyncRequestInfoResponse DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（DescribeAsyncRequestInfo）用于查询任务执行结果
    
    Parameters:
    
    req - DescribeAsyncRequestInfoRequest
    
    Returns:
    
    DescribeAsyncRequestInfoResponse
    
    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
  - DescribeRegionConf
```
public DescribeRegionConfResponse DescribeRegionConf(DescribeRegionConfRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DescribeRegionConf）用于查询可售卖订阅实例的地域
    
    Parameters:
    
    req - DescribeRegionConfRequest
    
    Returns:
    
    DescribeRegionConfResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSubscribeConf
```
public DescribeSubscribeConfResponse DescribeSubscribeConf(DescribeSubscribeConfRequest req)
                                                    throws TencentCloudSDKException
```
    本接口（DescribeSubscribeConf）用于查询订阅实例配置
    
    Parameters:
    
    req - DescribeSubscribeConfRequest
    
    Returns:
    
    DescribeSubscribeConfResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSubscribes
```
public DescribeSubscribesResponse DescribeSubscribes(DescribeSubscribesRequest req)
                                              throws TencentCloudSDKException
```
    本接口(DescribeSubscribes)获取数据订阅实例信息列表，默认分页，每次返回20条
    
    Parameters:
    
    req - DescribeSubscribesRequest
    
    Returns:
    
    DescribeSubscribesResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateSubscribe
```
public IsolateSubscribeResponse IsolateSubscribe(IsolateSubscribeRequest req)
                                          throws TencentCloudSDKException
```
    本接口（IsolateSubscribe）用于隔离小时计费的订阅实例。调用后，订阅实例将不能使用，同时停止计费。
    
    Parameters:
    
    req - IsolateSubscribeRequest
    
    Returns:
    
    IsolateSubscribeResponse
    
    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
  - ModifySubscribeAutoRenewFlag
```
public ModifySubscribeAutoRenewFlagResponse ModifySubscribeAutoRenewFlag(ModifySubscribeAutoRenewFlagRequest req)
                                                                  throws TencentCloudSDKException
```
    修改订阅实例自动续费标识
    
    Parameters:
    
    req - ModifySubscribeAutoRenewFlagRequest
    
    Returns:
    
    ModifySubscribeAutoRenewFlagResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySubscribeConsumeTime
```
public ModifySubscribeConsumeTimeResponse ModifySubscribeConsumeTime(ModifySubscribeConsumeTimeRequest req)
                                                              throws TencentCloudSDKException
```
    本接口(ModifySubscribeConsumeTime)用于修改数据订阅通道的消费时间点
    
    Parameters:
    
    req - ModifySubscribeConsumeTimeRequest
    
    Returns:
    
    ModifySubscribeConsumeTimeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySubscribeName
```
public ModifySubscribeNameResponse ModifySubscribeName(ModifySubscribeNameRequest req)
                                                throws TencentCloudSDKException
```
    本接口(ModifySubscribeName)用于修改数据订阅实例的名称
    
    Parameters:
    
    req - ModifySubscribeNameRequest
    
    Returns:
    
    ModifySubscribeNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySubscribeObjects
```
public ModifySubscribeObjectsResponse ModifySubscribeObjects(ModifySubscribeObjectsRequest req)
                                                      throws TencentCloudSDKException
```
    本接口(ModifySubscribeObjects)用于修改数据订阅通道的订阅规则
    
    Parameters:
    
    req - ModifySubscribeObjectsRequest
    
    Returns:
    
    ModifySubscribeObjectsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySubscribeVipVport
```
public ModifySubscribeVipVportResponse ModifySubscribeVipVport(ModifySubscribeVipVportRequest req)
                                                        throws TencentCloudSDKException
```
    本接口(ModifySubscribeVipVport)用于修改数据订阅实例的IP和端口号
    
    Parameters:
    
    req - ModifySubscribeVipVportRequest
    
    Returns:
    
    ModifySubscribeVipVportResponse
    
    Throws:
    
    TencentCloudSDKException
  - OfflineIsolatedSubscribe
```
public OfflineIsolatedSubscribeResponse OfflineIsolatedSubscribe(OfflineIsolatedSubscribeRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（OfflineIsolatedSubscribe）用于下线已隔离的数据订阅实例
    
    Parameters:
    
    req - OfflineIsolatedSubscribeRequest
    
    Returns:
    
    OfflineIsolatedSubscribeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetSubscribe
```
public ResetSubscribeResponse ResetSubscribe(ResetSubscribeRequest req)
                                      throws TencentCloudSDKException
```
    本接口(ResetSubscribe)用于重置数据订阅实例，已经激活的数据订阅实例，重置后可以使用ActivateSubscribe接口绑定其他的数据库实例
    
    Parameters:
    
    req - ResetSubscribeRequest
    
    Returns:
    
    ResetSubscribeResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartMigrateJob
```
public StartMigrateJobResponse StartMigrateJob(StartMigrateJobRequest req)
                                        throws TencentCloudSDKException
```
    本接口（StartMigrationJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。调用此接口前，请务必先使用CreateMigrateCheckJob校验数据迁移任务，并通过DescribeMigrateJobs接口查询到任务状态为校验通过（status=4）时，才能启动数据迁移任务。
    
    Parameters:
    
    req - StartMigrateJobRequest
    
    Returns:
    
    StartMigrateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopMigrateJob
```
public StopMigrateJobResponse StopMigrateJob(StopMigrateJobRequest req)
                                      throws TencentCloudSDKException
```
    本接口（StopMigrateJob）用于撤销数据迁移任务。在迁移过程中允许调用该接口撤销迁移, 撤销迁移的任务会失败。通过DescribeMigrateJobs接口查询到任务状态为运行中（status=7）或准备完成（status=8）时，才能撤销数据迁移任务。
    
    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

ActivateSubscribe

CompleteMigrateJob

CreateMigrateCheckJob

CreateMigrateJob

CreateSubscribe

DeleteMigrateJob

DescribeAsyncRequestInfo

DescribeMigrateCheckJob

DescribeMigrateJobs

DescribeRegionConf

DescribeSubscribeConf

DescribeSubscribes

IsolateSubscribe

ModifyMigrateJob

ModifySubscribeAutoRenewFlag

ModifySubscribeConsumeTime

ModifySubscribeName

ModifySubscribeObjects

ModifySubscribeVipVport

OfflineIsolatedSubscribe

ResetSubscribe

StartMigrateJob

StopMigrateJob