Preview the OpenAPI request parameters for a Data Transmission Service (DTS) task directly from the DTS console. Use the previewed parameters as a reference when calling the corresponding API operations programmatically.
Stop at the preview step — do not click through to the next action if you only want to view the parameters. Otherwise, the related operations will take effect, which may incur fees or cause configuration changes of the instance.
Prerequisites
Before you begin, ensure that you have:
A DTS task in any of the following categories: data synchronization, data migration, change tracking, or data verification
Access to the DTS console
Preview API parameters
Log on to the DTS console.
In the left-side navigation pane, click Data Synchronization, Data Migration, Change Tracking, or Data Verification based on your task type.
In the top navigation bar, select the region where your DTS instance resides.
Go to the task configuration page. The task configuration page is accessible when you create a task, modify the objects to be synchronized or tracked, or create a task similar to an existing one. For details, see Overview of data synchronization scenarios, Overview of data migration scenarios, Overview of change tracking scenarios, Configure a data verification task, Modify the objects to be synchronized, Change the objects for change tracking, and Create a similar instance.
Complete the Configure Task Objects step until the Next: Save Task Settings and Precheck or Next: Precheck and Start Task button appears at the bottom of the page. Depending on the task type and the source and destination database types, you may need to go through the Advanced Settings, Data Verification, or Configure Database and Table Fields phase before reaching this button.
Hover over the Next: Save Task Settings and Precheck or Next: Precheck and Start Task button, then click Preview OpenAPI parameters.
In the Preview API Request Parameters dialog box, click the JSON or Tree tab to view the parameters.
Clean up the parameters before use
The parameters shown in the Preview API Request Parameters dialog box are for reference only. Before using them in an actual API call, clean up the output:
Remove extra backslashes (
\), line feeds, and spaces.Fix nested double quotation marks (
"). If a parameter value contains a double-quoted string nested inside another double-quoted string, either escape the inner quotes with backslashes (\) or remove the outer quotes if the format allows it.
What's next
Use the previewed parameters with the following API operations: