This topic describes how to preview the request parameters of API operations in the Data Transmission Service (DTS) console. This helps you configure the request parameters when you call the API operations related to DTS tasks.
Usage notes
The API operation parameters displayed in the DTS console are for reference only. When you configure request parameters to call the corresponding API operations, you must manually delete extra backslashes (\), line feeds, and spaces. Make sure that the specified parameters meet relevant requirements. For example, make sure that parameters in JSON format do not contain nested double quotation marks (").
If a parameter in JSON format contains nested double quotation marks ("), that is, a pair of double quotation marks is enclosed in another pair of double quotation marks in the parameter, you must use backslashes (\) to escape the inner double quotation marks or remove the outer double quotation marks if the format requirements are met.
If you only want to view the request parameters of an API operation, do not perform subsequent operations after you view the parameters in the DTS console. Otherwise, the related operations will take effect, which may incur fees or cause configuration changes of the instance.
Procedure
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 business requirements.
In the top navigation bar, select the region in which your DTS instance resides.
Go to the task configuration page.
You can go to the task configuration page when you create a data synchronization, data migration, change tracking, or data verification task, modify the objects to be synchronized or for change tracking, or create a task similar to an existing task. For more information, 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.
Enter the last phase of the Configure Task Objects step. The Next: Save Task Settings and Precheck or Next: Precheck and Start Task button appears in the lower part of the page.
The required phase varies based on the task type, source database type, and destination database type. You may need to enter the Advanced Settings, Data Verification, or Configure Database and Table Fields phase.
Move the pointer over the Next: Save Task Settings and Precheck or Next: Precheck and Start Task button, and click Preview OpenAPI parameters.
In the Preview API Request Parameters dialog box, click the JSON or Tree tab to view the parameters.
