文档中心

API 概览

最近更新时间：2024.03.27 15:36:11

首次发布时间：2023.03.29 20:39:10

本文汇总数据库传输服务 DTS 提供的 API 接口。

说明

单个地域下，数据库传输服务 DTS 的 API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。

计费

API	描述
ModifyInstanceOrder	调用 ModifyInstanceOrder 接口修改任务的计费配置。

数据传输

API	描述
CreateTransmissionTask	调用 CreateTransmissionTask 接口创建数据库传输服务任务。
DescribeTransmissionTaskProgress	调用 DescribeTransmissionTaskProgress 接口查询传输任务进度。
DescribeTransmissionTasks	调用 DescribeTransmissionTasks 接口查看传输任务列表。
DescribeTransmissionTaskInfo	调用 DescribeTransmissionTaskInfo 接口查看传输任务详情。
ResumeTransmissionTask	调用 ResumeTransmissionTask 接口恢复失败的传输任务。
ResumeTransmissionTasks	调用 ResumeTransmissionTasks 接口批量恢复暂停的传输任务。
StartTransmissionTask	调用 StartTransmissionTask 启动传输任务。
StartTransmissionTasks	调用 StartTransmissionTasks 接口批量启动传输任务。
DeleteTransmissionTask	调用 DeleteTransmissionTask 接口删除传输任务。
DeleteTransmissionTasks	调用 DeleteTransmissionTasks 接口批量删除传输任务。
ModifyTransmissionTask	调用 ModifyTransmissionTask 接口修改传输任务。
RetryTransmissionTask	调用 RetryTransmissionTask 接口重试传输任务。
RetryTransmissionTasks	调用 RetryTransmissionTasks 接口批量重试失败的传输任务。
SuspendTransmissionTask	调用 SuspendTransmissionTask 接口暂停传输任务。
StopTransmissionTask	调用 StopTransmissionTask 接口终止传输任务。
StopTransmissionTasks	调用 StopTransmissionTasks 接口批量终止传输任务。
SpawnSwimmingLane	调用 SpawnSwimmingLane 接口配置延迟隔离。
SuspendTransmissionTasks	调用 SuspendTransmissionTasks 接口批量暂停传输任务。

数据订阅（消费组管理）

API	描述
CreateSubscriptionGroup	调用 CreateSubscriptionGroup 接口创建订阅消费组。
DescribeSubscriptionGroup	调用 DescribeSubscriptionGroup 接口查询订阅消息组。
DescribeSubscriptionGroups	调用 DescribeSubscriptionGroups 接口查询消费组列表。
DescribeSubscriptionGroupProgress	调用 DescribeSubscriptionGroupProgress 接口查询订阅消费组进度。
DeleteSubscriptionGroup	调用 DeleteSubscriptionGroup 接口删除消费组。
UpdateSubscriptionGroup	调用 UpdateSubscriptionGroup 接口修改消费组信息。

标签管理

API	描述
AddTagsToResource	调用 AddTagsToResource 为任务添加标签。
DescribeTagsByResource	调用 DescribeTagsByResource 查询任务标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口解绑任务标签。

数据校验

API	描述
CreateDataValidationTask	调用 CreateDataValidationTask 接口创建数据校验任务。
DescribeDataValidationTasks	调用 DescribeDataValidationTasks 接口查询数据校验任务。
SuspendDataValidationTask	调用 SuspendDataValidationTask 接口暂停数据校验任务。
ResumeDataValidationTask	调用 ResumeDataValidationTask 接口恢复数据校验任务。
DeleteDataValidationTask	调用 DeleteDataValidationTask 接口删除数据校验任务。
StopDataValidationTask	调用 StopDataValidationTask 接口终止数据校验任务。

预检查

API	描述
PreCheckAsync	调用 PreCheckAsync 接口创建并启动数据库传输服务 DTS 的预检查任务。
GetAsyncPreCheckResult	调用 GetAsyncPreCheckResult 接口查看预检查结果。

计费

数据传输

数据订阅（消费组管理）

标签管理

数据校验

预检查