概述--数据库传输服务-火山引擎

文档中心

导航

概述

最近更新时间：2024.10.28 17:46:00首次发布时间：2023.07.18 16:13:48

为提高使用便利性和扩展性，满足更多业务场景需求，数据库传输服务 DTS 提供了 OpenAPI-SDK。在本地安装 SDK 后，即可基于数据库传输服务 DTS 提供的 OpenAPI 进行开发。

SDK 列表

数据库传输服务 DTS 当前提供了 Python 和 Go 语言的 SDK。详细信息如下表所示。

语言	下载地址	使用指导
Python	DTS Python SDK	Python SDK
Go	DTS Go SDK	Go SDK

Go SDK 支持的 OpenAPI 接口

数据传输

接口名称	描述
CreateTransmissionTask	调用 CreateTransmissionTask 接口创建数据库传输服务任务。
DescribeTransmissionTaskProgress	调用 DescribeTransmissionTaskProgress 接口查询传输任务进度。
StopTransmissionTasks	调用 StopTransmissionTasks 接口批量终止传输任务。
DeleteTransmissionTasks	调用 DeleteTransmissionTasks 接口批量删除传输任务。
ResumeTransmissionTasks	调用 ResumeTransmissionTasks 接口批量恢复暂停的传输任务。
StartTransmissionTasks	调用 StartTransmissionTasks 接口批量启动传输任务。
RetryTransmissionTasks	调用 RetryTransmissionTasks 接口批量重试失败的传输任务。
SuspendTransmissionTasks	调用 SuspendTransmissionTasks 接口批量暂停传输任务。
DescribeTransmissionTaskInfo	调用 DescribeTransmissionTaskInfo 接口查看传输任务详情。
DeleteTransmissionTask	调用 DeleteTransmissionTask 接口删除传输任务。
RetryTransmissionTask	调用 RetryTransmissionTask 接口重试传输任务。
StopTransmissionTask	调用 StopTransmissionTask 接口终止传输任务。
StartTransmissionTask	调用 StartTransmissionTask 启动传输任务。
SuspendTransmissionTask	调用 SuspendTransmissionTask 接口暂停传输任务。
ModifyTransmissionTask	调用 ModifyTransmissionTask 接口修改传输任务。
DescribeTransmissionTasks	调用 DescribeTransmissionTasks 接口查看传输任务列表。
ResumeTransmissionTask	调用 ResumeTransmissionTask 接口恢复失败的传输任务。
SetBiSyncDDLSource	调用 SetBiSyncDDLSource 接口调转双向同步任务的 DDL 同步方向。

数据校验

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

数据订阅

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

预检查

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

Python SDK 支持的 OpenAPI 接口

数据传输

接口名称	描述
CreateTransmissionTask	调用 CreateTransmissionTask 接口创建数据库传输服务任务。
StartTransmissionTask	调用 StartTransmissionTask 启动传输任务。
StopTransmissionTask	调用 StopTransmissionTask 接口终止传输任务。
SuspendTransmissionTask	调用 SuspendTransmissionTask 接口暂停传输任务。
ResumeTransmissionTask	调用 ResumeTransmissionTask 接口恢复失败的传输任务。
RetryTransmissionTask	调用 RetryTransmissionTask 接口重试传输任务。
DeleteTransmissionTask	调用 DeleteTransmissionTask 接口删除传输任务。
ModifyTransmissionTask	调用 ModifyTransmissionTask 接口修改传输任务。
DescribeTransmissionTaskProgress	调用 DescribeTransmissionTaskProgress 接口查询传输任务进度。
DescribeTransmissionTaskInfo	调用 DescribeTransmissionTaskInfo 接口查看传输任务详情。
DescribeTransmissionTasks	调用 DescribeTransmissionTasks 接口查看传输任务列表。

预检查

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