Updated on 2023-10-24 GMT+08:00

API Overview

DRS provides REST APIs. With DRS APIs, you can use all the functions of DRS, including creating migration tasks, obtaining task details, obtaining the migration task list, and deleting migration tasks.

Table 1 v3 APIs

Type

Subtype

Description

DRS APIs (v3)

Quotas

The APIs are used to query quotas.

DRS APIs (v3)

Public API management

The APIs are used to create a task, test the connection, perform a pre-check, query task details and progress, create a comparison task, delete a task, retry a task, and stop a task.

DRS APIs (v3)

Real-Time migration management

The APIs are used to obtain migration users of the source database and update user information.

DRS APIs (v3)

Real-time synchronization management

The APIs are used to process data and set the synchronization policy.

DRS APIs (v3)

Real-time disaster recovery management

The APIs are used to perform a primary/standby switchover and query RPO, RTO, DR monitoring data, and DR initialization progress.

Table 2 DRS APIs (v5)

Type

Subtype

Description

DRS APIs (v5)

Resource management

The APIs are used to query available link information.

DRS APIs (v5)

Task management

The common APIs are used to create, query, update, and delete tasks.

DRS APIs (v5)

Comparison management

The APIs are used to query the comparison policy, health comparison list, and data-level streaming comparison list.

DRS APIs (v5)

Management of tasks created asynchronously in batches

The common APIs are used to asynchronously create tasks in batches, and submit, query, and update the tasks created asynchronously in batches.

DRS APIs (v5)

Database object configuration

The APIs are used to query database object information and import object files.

DRS APIs (v5)

Task details

The APIs are used to query task details.

DRS APIs (v5)

Task operations

The APIs are used to perform task operations.

DRS APIs (v5)

Enterprise project management

This API is used to query enterprise projects.

DRS APIs (v5)

Data processing

The APIs are used to update data processing rules, query data processing rules, and verify data filtering rules.

DRS APIs (v5)

Tag management

The APIs are used to add, delete, and query tags.