数据传输服务DTS提供以下API接口。
说明 以下接口将于2022年1月1日停止维护,推荐您使用新版API。
数据迁移
| API | 描述 |
|---|---|
| CreateMigrationJob | 购买迁移实例。 |
| ConfigureMigrationJob | 配置迁移实例。 |
| StartMigrationJob | 启动迁移实例。 |
| SuspendMigrationJob | 暂停迁移实例。 |
| DescribeMigrationJobs | 查询迁移实例列表和各迁移实例的详情。 |
| DescribeMigrationJobDetail | 查询一个迁移实例的任务详情。 |
| DescribeMigrationJobStatus | 查询一个迁移实例的任务状态。 |
| StopMigrationJob | 结束迁移实例。 |
| DeleteMigrationJob | 释放迁移实例。 |
数据同步
| API | 描述 |
|---|---|
| CreateSynchronizationJob | 购买同步实例。 |
| ConfigureSynchronizationJob | 配置同步实例。 |
| StartSynchronizationJob | 启动同步实例。 |
| SuspendSynchronizationJob | 暂停同步实例。 |
| ResetSynchronizationJob | 清空同步实例配置。 |
| ModifySynchronizationObject | 修改同步对象。 |
| DescribeSynchronizationObjectModifyStatus | 查询同步对象变更状态。 |
| SwitchSynchronizationEndpoint | 更改数据库连接信息。 |
| DescribeEndpointSwitchStatus | 查询更改数据库连接信息的任务执行状态。 |
| ConfigureSynchronizationJobReplicatorCompare | 配置一个同步实例的全镜像匹配开关。 |
| DescribeSynchronizationJobReplicatorCompare | 查询一个同步实例的全镜像匹配开关状态。 |
| DescribeSynchronizationJobs | 查询同步实例列表和各同步实例的详情。 |
| DescribeInitializationStatus | 查询同步初始化详情,即待同步对象的结构和存量数据初始化到目标库的情况。 |
| DescribeSynchronizationJobStatusList | 查询一个或多个同步实例状态。 |
| DescribeSynchronizationJobStatus | 查询一个同步实例状态。 |
| DeleteSynchronizationJob | 释放同步实例。 |
数据订阅
| API | 描述 |
|---|---|
| CreateSubscriptionInstance | 购买订阅实例。 |
| ConfigureSubscriptionInstance | 配置订阅实例。 |
| StartSubscriptionInstance | 启动订阅实例。 |
| ModifySubscriptionObject | 修改订阅对象。 |
| 管理消费组: | 管理消费组:
|
| DescribeSubscriptionInstances | 查询订阅实例列表和各订阅实例详情。 |
| DescribeSubscriptionInstanceStatus | 查询一个订阅实例的状态。 |
| DeleteSubscriptionInstance | 释放订阅实例。 |
网络设置
| API | 描述 |
|---|---|
| DescribeDTSIP | 查询DTS服务的IP地址。 |
| DescribeConnectionStatus | 查询DTS服务器与源库和目标库的连通性。 |
监控报警
| API | 描述 |
|---|---|
| ConfigureMigrationJobAlert | 配置数据迁移实例的监控报警。 |
| DescribeMigrationJobAlert | 查询数据迁移实例的监控报警设置。 |
| ConfigureSubscriptionInstanceAlert | 配置数据订阅实例的监控报警。 |
| DescribeSubscriptionInstanceAlert | 查询数据订阅实例的监控报警设置。 |
| ConfigureSynchronizationJobAlert | 配置数据同步实例的监控报警。 |
| DescribeSynchronizationJobAlert | 查询数据同步实例的监控报警设置。 |
标签管理
| API | 描述 |
|---|---|
| TagResources | 为一个或多个迁移、同步和订阅实例绑定标签。 |
| ListTagResources | 查询迁移、同步和订阅实例绑定的标签,也可以查询标签所绑定的实例。 |
| UntagResources | 为迁移、同步和订阅实例解绑标签。 |
任务管理
| API | 描述 |
|---|---|
| ShieldPrecheck | 屏蔽迁移或同步时导致预检查失败的告警项。 |