All Products
Search
Document Center

Data Transmission Service:DTS API (new and recommended)

Last Updated:Nov 28, 2024

The following table describes the API operations that are available for use in Data Transmission Service (DTS).

API

Description

CreateDtsInstance

Purchases a DTS instance.

ConfigureDtsJob

Configures a data migration or synchronization task.

ConfigureSubscription

Configures a change tracking task.

WhiteIpList

Queries the CIDR blocks of DTS servers. After you call this operation, you can add the CIDR blocks of DTS servers to the security settings of the source or destination instance.

StartDtsJob

Starts a data migration, data synchronization, or change tracking task.

Operations that are used to manage consumer groups for a change tracking task:

Manage consumer groups for a change tracking task. You can add a consumer group, query the information about a consumer group, modify the information about a consumer group, or delete a consumer group.

SkipPreCheck

Skips one or more precheck items.

Operations that are used to query data synchronization, data migration, or change tracking tasks:

Operations that are used to query data synchronization, data migration, or change tracking tasks:

  • Queries the details of a data migration, data synchronization, or change tracking task.

  • Queries the DTS tasks and the details of each task.

  • Queries the status of a DTS subtask that performs precheck, schema migration, initial schema synchronization, full data migration, initial full data synchronization, incremental data migration, or incremental data synchronization.

Operations that are used to query DTS verification tasks:

Operations that are used to query DTS verification tasks:

  • Queries the details of a data verification task.

  • Queries the information about inconsistent data in a table in a data verification task.

Operations that are used to modify the configurations of a DTS task:

Operations that are used to modify the configurations of a DTS task:

  • Modifies the objects of a data synchronization task.

  • Modifies the objects of a change tracking task and the types of data changes to be tracked.

  • Changes the password of the source or destination database account.

  • Changes the name of a DTS task.

  • Upgrades the synchronization topology of a data synchronization instance from one-way synchronization to two-way synchronization.

  • Changes the billing method or instance class of a DTS task.

  • Upgrades or downgrades a DTS instance.

  • Renews a DTS instance. This API operation is applicable to only subscription instances.

ResetDtsJob

Resets a data synchronization or change tracking task.

SuspendDtsJob

Pauses a data migration, data synchronization, or change tracking task.

StopDtsJob

Stops a data migration, data synchronization, or change tracking task.

DeleteDtsJob

Deletes a data migration, data synchronization, or change tracking task.

Operations that are used to manage alert rules for a DTS task:

Creates an alert rule for a DTS task, modifies the alert rule of a DTS task, or queries the alert rules of a DTS task.

Operations that are used to manage tags:

Operations that are used to manage tags:

  • Adds tags to one or more data migration, data synchronization, or change tracking instances.

  • Queries the tags that are added to specific data migration, data synchronization, or change tracking instances, or queries the instances to which specific tags are added.

  • Removes tags from one or more data migration, data synchronization, or change tracking instances.

Operations that are used to manage dedicated clusters:

Operations that are used to manage dedicated clusters:

  • Queries a list of clusters.

  • Queries the details of a cluster.

  • Queries the resource usage of a cluster.

  • Queries the operation logs of a cluster.

  • Queries the monitoring information about a cluster.

  • Modifies the configurations of a cluster.

  • Modifies the upper limit of DTS units (DUs) for a DTS task.

  • Releases a cluster.

  • Migrates tasks from a dedicated cluster to a shared cluster.

  • Creates an alert rule.

  • Queries alert rules.