API Overview

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	This API is used to create a cluster.	5
	Querying the Cluster List	This API is used to query and display the cluster list.	120
	Querying Cluster Details	This API is used to query the details of a cluster.	120
	Restarting a Cluster	This API is used to restart a CDM cluster.	20
	Deleting a Cluster	This API is used to delete a specified CDM cluster.	20
	Stopping a Cluster	This API is used to stop a specified CDM cluster.	20
	Querying All AZs	This API is used to query all AZs.	20
	Querying Supported Versions	This API is used to query supported cluster versions.	20
	Querying a Flavor	This API is used to query the flavor of a cluster version.	20
	Querying Details About a Flavor	This API is used to query the details of a cluster flavor.	20
	Querying the Enterprise Project IDs of All Clusters	This API is used to query the enterprise project IDs of all clusters.	20
	Querying the Enterprise Project ID of a Specified Cluster	This API is used to query the enterprise project ID of a specified cluster.	20
	Query a Specified Instance in a Cluster	This API is used to query a specified instance in a cluster.	20
	Modifying a Cluster	This API is used to modify a specified CDM cluster.	20
	Starting a Cluster	This API is used to start a specified CDM cluster.	20
Link Management	Creating a Link	This API is used to connect to a specified data source.	120
	Querying a Link	This API is used to query a link.	120
	Modifying a Link	This API is used to modify a link.	120
	Deleting a Link	This API is used to delete a specified link.	120
Job Management	Creating a Job in a Specific Cluster	This API is used to create 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	This API is used to create and run a data migration job in a random CDM cluster.	120
	Querying the Job List	This API is used to query the job list.	120
	Modifying a Job	This API is used to modify a job.	120
	Starting a Job	This API is used to start a data migration job.	1,200
	Stopping a Job	This API is used to stop a running job.	1,200
	Querying Job Status	This API is used to query the status of a job.	120
	Querying Job Execution History	This API is used to query the execution history of a job.	120
	Deleting a Job	This API is used to delete a job.	120

Precautions

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.

Previous topic: Concepts

Next topic: Calling APIs