API Overview

Updated on 2022-09-15 GMT+08:00

View PDF

CDM provides self-developed APIs. You can perform the following operations with CDM APIs.

**Table 1** CDM APIs
Type	API	Description	Maximum Number of Requests Made Per User Per Minute
Cluster Management	Creating a Cluster	Creates a cluster.	5
	Querying the Cluster List	Queries and displays the cluster list.	120
	Querying Cluster Details	Queries cluster details.	120
	Restarting a Cluster	Restarts a cluster.	20
	Deleting a Cluster	Deletes a cluster.	20
	Stopping a Cluster	Stops a specified cluster.	20
	Starting a Cluster	Starts a specified cluster.	20
Link Management	Creating a Link	Connects to a data source.	120
	Querying a Link	Queries the link list.	120
	Modifying a Link	Modifies the link configuration.	120
	Deleting a Link	Deletes a link.	120
Job Management	Creating a Job in a Specific Cluster	Creates a data migration job in a specific CDM cluster. The job will not automatically start.	1,200
	Creating and Executing a Job in a Random Cluster	Selects a random cluster in the running state from the specified clusters and creates and executes a data migration job.	120
	Querying a Job	Queries and displays the job list.	120
	Modifying a Job	Modifies the job configuration.	120
	Starting a Job	Starts a data migration job.	1,200
	Stopping a Job	Stops a running job.	1,200
	Querying Job Status	Queries and displays the running status of a job.	120
	Querying Job Execution History	Queries and displays the historical status of job execution.	120
	Deleting a Job	Deletes a job.	120

CDM jobs carry large volumes of data, which increases the database load. You are advised to periodically delete unused jobs.
If a large number of jobs are delivered in a short period, cluster resources may be exhausted.
CDM is a batch offline migration tool. You are advised not to create a large number of small jobs using CDM.