数据传输_API文档

数据传输 - OpenAPI 概览2020-01-01
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
数据管理
OpenAPI 名称描述操作
DescribeDTSIPhot获取源库和目标库的白名单都需要添加的DTS IP地址查看文档去调试
DescribeEndpointSwitchStatus可以查看任务的执行状态查看文档去调试
DescribeInitializationStatus老版获取初始化状态查看文档去调试
ShieldPrecheck老版屏蔽预检查查看文档去调试
数据迁移
OpenAPI 名称描述操作
CreateMigrationJobhot购买一个数据迁移实例查看文档去调试
DescribeMigrationJobDetail老版获取数据迁移任务执行详情查看文档去调试
DescribeMigrationJobs查询数据迁移实例列表和各迁移实例的详情查看文档去调试
DescribeMigrationJobStatus老版查询数据迁移任务的状态查看文档去调试
DescribeConnectionStatus测试迁移任务的执行节点与源库、目标库的连通性查看文档去调试
StartMigrationJob启动DTS的数据迁移任务查看文档去调试
StopMigrationJob结束处于迁移状态的数据迁移任务查看文档去调试
SuspendMigrationJob暂停处于迁移中的数据迁移任务查看文档去调试
ConfigureMigrationJobhot老版配置迁移任务查看文档去调试
DeleteMigrationJob释放数据迁移实例查看文档去调试
数据订阅
OpenAPI 名称描述操作
消费者通道
CreateConsumerChannel新版创建订阅任务消费组查看文档去调试
DescribeConsumerChannel查询DTS订阅任务的消费组信息,如消费组ID、名称和账号,消费延迟时间等查看文档去调试
ModifyConsumerChannel新版修改订阅通道中消费组的相关信息查看文档去调试
DeleteConsumerChannel新版删除订阅任务消费组查看文档去调试
消费组
CreateConsumerGroup为数据订阅实例新增消费组查看文档去调试
DescribeConsumerGroup查询数据订阅实例中的消费组详情查看文档去调试
ModifyConsumerGroupPassword老版修改消费组密码查看文档去调试
DeleteConsumerGroup删除订阅通道中的消费组查看文档去调试
CreateSubscriptionInstance老版创建数据订阅通道查看文档去调试
DescribeSubscriptionInstances查询订阅实例列表和各订阅实例详情查看文档去调试
DescribeSubscriptionInstanceStatus老版查看订阅通道实例状态详情查看文档去调试
StartSubscriptionInstance老版启动订阅数据订阅实例通道查看文档去调试
ModifySubscriptionObject老版修改订阅对象查看文档去调试
ModifyConsumptionTimestamp修改数据订阅实例通道的消费时间点查看文档去调试
DeleteSubscriptionInstance释放数据订阅实例通道查看文档去调试
ConfigureSubscription配置DTS订阅任务查看文档去调试
ConfigureSubscriptionInstance老版配置订阅通道查看文档去调试
数据同步
OpenAPI 名称描述操作
CreateSynchronizationJobhot老版创建一个数据同步作业实例查看文档去调试
DescribeSynchronizationJobReplicatorCompare老版获取当前镜像匹配开关配置查看文档去调试
DescribeSynchronizationJobshot通过DescribeSynchronizationJobs查询数据同步实例列表和各同步实例的详情查看文档去调试
DescribeSynchronizationJobStatus老版查询同步作业的运行状态查看文档去调试
DescribeSynchronizationJobStatusList老版获取同步作业状态列表查看文档去调试
DescribeSynchronizationObjectModifyStatus老版查询修改同步对象任务的执行状态查看文档去调试
StartSynchronizationJob启动数据同步作业查看文档去调试
ModifySynchronizationObject老版修改数据同步作业实例中的同步对象查看文档去调试
DeleteSynchronizationJob释放数据同步作业实例查看文档去调试
SuspendSynchronizationJob暂停处于同步中的数据同步作业查看文档去调试
ResetSynchronizationJob清空数据同步作业配置查看文档去调试
ConfigureSynchronizationJobReplicatorCompare配置同步全镜像匹配开关查看文档去调试
ConfigureSynchronizationJob老版配置数据同步作业查看文档去调试
SwitchSynchronizationEndpoint主备切换后新数据库的连接信息传给DTS,DTS将从断点处重新启动数据同步查看文档去调试
监控报警
OpenAPI 名称描述操作
DescribeMigrationJobAlert查询迁移任务的监控报警设置详情查看文档去调试
DescribeSynchronizationJobAlert查询同步作业的监控报警设置详情查看文档去调试
DescribeSubscriptionInstanceAlert查询数据订阅实例的监控报警设置详情查看文档去调试
ConfigureMigrationJobAlert配置监控报警,来监控迁移任务的延迟和异常状态查看文档去调试
ConfigureSynchronizationJobAlert配置监控报警,来监控同步作业的延迟和异常状态查看文档去调试
ConfigureSubscriptionInstanceAlert配置监控报警,来监控订阅通道的延迟和异常状态查看文档去调试
作业
OpenAPI 名称描述操作
DescribeDtsJobDetailhotThe latency of incremental data migration or synchronization. \\\> If you query data migration tasks, the unit of this parameter is milliseconds. If you query data synchronization tasks, the unit of this parameter is seconds.查看文档去调试
DescribeDtsJobshot查询DTS任务列表及各任务执行详情查看文档去调试
ConfigureDtsJobhot配置一个迁移或同步任务查看文档去调试
ModifyDtsJobhot修改同步任务查看文档去调试
ModifyDtsJobName修改DTS任务名称查看文档去调试
ModifyDtsJobPassword新版修改作业密码查看文档去调试
ResetDtsJob重置一个数据同步或订阅任务查看文档去调试
StartDtsJob启动一个迁移、同步或订阅任务查看文档去调试
StopDtsJob结束一个数据迁移、同步或订阅任务查看文档去调试
SuspendDtsJob暂停一个数据迁移、同步或订阅任务查看文档去调试
DeleteDtsJob释放一个数据迁移、同步或订阅实例查看文档去调试
标签管理
OpenAPI 名称描述操作
ListTagResources查询迁移、同步和订阅实例绑定的标签,也可以查询标签所绑定的实例查看文档去调试
TagResources为一个或多个迁移、同步和订阅实例绑定标签查看文档去调试
UntagResources为迁移、同步和订阅实例解绑标签查看文档去调试
资源组管理
OpenAPI 名称描述操作
ConvertInstanceResourceGroup为实例资源转资源组查看文档去调试
其他
OpenAPI 名称描述操作
CountJobByCondition按条件统计任务查看文档去调试
CreateDtsInstancehot购买DTS实例查看文档去调试
CreateJobMonitorRule创建或修改任务的告警规则查看文档去调试
DeleteDtsJobs批量释放数据迁移、同步或订阅任务查看文档去调试
DescribeDtsServiceLog查询一个数据迁移或同步任务的日志信息查看文档去调试
DescribeJobMonitorRule查询DTS任务的告警规则查看文档去调试
DescribePreCheckStatus查询DTS任务的子任务执行详情,包括预检查、库表结构迁移或初始化、全量迁移或初始化、增量迁移或同步查看文档去调试
DescribeSubscriptionMeta查询PolarDB-X 1.0分布式订阅任务下子任务的信息查看文档去调试
DescribeTagKeys查找一个迁移、同步或订阅实例绑定的所有标签查看文档去调试
DescribeTagValues查找一个迁移、同步或订阅实例绑定的标签键对应的所有值查看文档去调试
InitDtsRdsInstance在全球多活数据库集群的节点中初始化一个内置账号,DTS使用该账号连接节点并进行同步任务查看文档去调试
ModifySubscription新版修改订阅任务查看文档去调试
RenewInstance可以为DTS实例续费。本接口仅适用于预付费类型的DTS实例查看文档去调试
SkipPreCheck屏蔽或取消屏蔽预检查告警项目查看文档去调试
StartDtsJobs批量启动数据迁移或同步任务查看文档去调试
StopDtsJobs批量结束DTS任务查看文档去调试
SummaryJobDetail统计DTS数据迁移或同步任务中迁移表的数量查看文档去调试
SuspendDtsJobs批量暂停DTS任务查看文档去调试
TransferInstanceClass可以升级或降级DTS实例规格查看文档去调试
TransferPayType新版转换支付方式查看文档去调试
UpgradeTwoWay将DTS同步实例的同步拓扑从单向同步升级为双向同步查看文档去调试
WhiteIpList查询DTS服务器的IP地址查看文档去调试
DescribeDtsEtlJobVersionInfo查看ETL任务详情查看文档去调试
DescribeEtlJobLogs查看ETL任务运行日志查看文档去调试
CreateDedicatedClusterMonitorRule创建报警规则查看文档去调试
DescribeClusterOperateLogs查询DTS集群日志信息查看文档去调试
DescribeClusterUsedUtilization查看集群当前使用量查看文档去调试
DescribeDedicatedClusterMonitorRule查询报警规则查看文档去调试
DescribeDedicatedCluster获得集群的详细信息查看文档去调试
DescribeMetricList查看集群监控信息查看文档去调试
ListDedicatedCluster查询当前用户创建的所有集群,也可以按照传入的条件信息筛选指定的集群查看文档去调试
ModifyDtsJobDedicatedCluster更换任务运行的独享集群查看文档去调试
ModifyDedicatedCluster修改集群配置查看文档去调试
ModifyDtsJobDuLimit修改作业DU上限查看文档去调试
StopDedicatedCluster释放集群查看文档去调试
DescribeDataCheckTableDiffDetails以不一致数据为维度的列表结果查看文档去调试
DescribeDataCheckTableDetails以表为维度的列表结果查看文档去调试
DescribeDataCheckReportUrl以不一致数据为维度的列表数据的下载连接查看文档去调试
DescribeCheckJobs包含迁移任务关联的校验任务和同步任务关联的校验任务查看文档去调试
SwitchPhysicalDtsJobToCloudMSSQL物理迁移上云查看文档去调试
ModifyDynamicConfig调整同步或迁移实例的迁移速率查看文档去调试
ModifyDtsJobConfig修改DTS任务参数查看文档去调试
StartReverseWriter启动CreateReverseDtsJob接口创建的反向任务查看文档去调试
CreateReverseDtsJob为目标同步或迁移任务创建一个反向任务查看文档去调试
ModifyDtsJobEndpoint修改DTS同步或迁移任务的源或目标库实例查看文档去调试
其它
OpenAPI 名称描述操作
SkipFullJobTable跳过全量阶段不需要同步的表查看文档去调试
DescribeFullProcessList描述完整流程列表查看文档去调试
ModifyGadInstanceName修改GAD实例组名称查看文档去调试
DescribePreCheckCreateGadOrderResult查询预检查结果查看文档去调试
DetachGadInstanceDbMember移除从角色查看文档去调试
PreCheckCreateGadOrderGAD全球热活实例组创建预检查查看文档去调试
DescribeGadInstances查询热活实例组列表查看文档去调试