All Products
Search
Document Center

Data Transmission Service:DTS API (discontinued maintenance)

Last Updated:Dec 12, 2024

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

Data migration

Operation

Description

CreateMigrationJob

Purchases a data migration instance.

ConfigureMigrationJob

Configures a data migration task.

StartMigrationJob

Starts a data migration task.

SuspendMigrationJob

Pauses a data migration task.

DescribeMigrationJobs

Queries the list of data migration instances and the details of each instance.

DescribeMigrationJobDetail

Queries the details of a data migration task.

DescribeMigrationJobStatus

Queries the status of a data migration task.

StopMigrationJob

Stops a data migration task.

DeleteMigrationJob

Releases a change tracking instance.

Data synchronization

Operation

Description

CreateSynchronizationJob

Purchases a data synchronization instance.

ConfigureSynchronizationJob

Configures a data synchronization task.

StartSynchronizationJob

Starts a data synchronization task.

SuspendSynchronizationJob

Pauses a data synchronization task.

ResetSynchronizationJob

Clears the configurations of a data synchronization task.

ModifySynchronizationObject

Changes the objects to be synchronized.

DescribeSynchronizationObjectModifyStatus

Queries the status of the task that changes the objects to be synchronized.

SwitchSynchronizationEndpoint

Changes the database connection settings.

DescribeEndpointSwitchStatus

Queries the status of the task that changes the database connection settings.

ConfigureSynchronizationJobReplicatorCompare

Enables or disables image matching for a data synchronization instance.

DescribeSynchronizationJobReplicatorCompare

Queries whether image matching is enabled for a data synchronization instance.

DescribeSynchronizationJobs

Queries the list of data synchronization instances and the details of each instance.

DescribeInitializationStatus

Queries the details of initial data synchronization, including the information about the schemas and historical data of the object to be synchronized.

DescribeSynchronizationJobStatusList

Queries the status of one or more data synchronization instances.

DescribeSynchronizationJobStatus

Queries the status of a data synchronization instance.

DeleteSynchronizationJob

Releases a data synchronization instance.

Change tracking

Operation

Description

CreateSubscriptionInstance

Purchases a change tracking instance.

ConfigureSubscriptionInstance

Configures a change tracking task.

StartSubscriptionInstance

Starts a change tracking task.

ModifySubscriptionObject

Changes the objects for change tracking.

Manage consumer groups:

Manage consumer groups:

  • Creates a consumer group.

  • Queries the details of consumer groups in a change tracking instance.

  • Changes the password of a consumer group.

  • Deletes a consumer group.

  • Changes the consumption checkpoint of a change tracking instance.

DescribeSubscriptionInstances

Queries the list of change tracking instances and the details of each instance.

DescribeSubscriptionInstanceStatus

Queries the status of a change tracking instance.

DeleteSubscriptionInstance

Releases a data migration instance.

Network settings

Operation

Description

DescribeDTSIP

Queries the CIDR blocks of DTS servers.

DescribeConnectionStatus

Queries the connectivity of DTS servers to the source and destination databases.

Monitoring

Operation

Description

ConfigureMigrationJobAlert

Configures alert settings for a data migration instance.

DescribeMigrationJobAlert

Queries the alert settings of a data migration instance.

ConfigureSubscriptionInstanceAlert

Configures alert settings for a change tracking instance.

DescribeSubscriptionInstanceAlert

Queries the alert settings of a change tracking instance.

ConfigureSynchronizationJobAlert

Configures alert settings for a data synchronization instance.

DescribeSynchronizationJobAlert

Queries the alert settings of a data synchronization instance.

Tag management

Operation

Description

TagResources

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

ListTagResources

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

UntagResources

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

Task management

Operation

Description

ShieldPrecheck

Ignores the precheck items that a data migration or synchronization task may fail to pass.

References