API Overview¶
DataArts Studio provides self-developed APIs that comply with RESTful API design specifications. You can call those APIs to perform operations on DataArts Studio.
DataArts Migration APIs¶
Type | API | Description | Maximum Number of Requests Made Per User Per Minute |
|---|---|---|---|
Creating a Cluster | Used to create a CDM cluster. | 5 | |
Querying the Cluster List | Used to query the list of CDM clusters. | 120 | |
Querying Cluster Details | Used to query the details of a CDM cluster. | 120 | |
Restarting a Cluster | Used to restart a CDM cluster. | 20 | |
Deleting a Cluster | Used to delete a CDM cluster. | 20 | |
Stopping a Cluster | Used to stop a CDM cluster. | 20 | |
Starting a Cluster | Used to start a CDM cluster. | 20 | |
Creating a Link | Used to connect to a data source. | 120 | |
Querying a Link | Used to query the link list. | 120 | |
Modifying a Link | Used to modify the link configuration. | 120 | |
Deleting a Link | Used to delete a link. | 120 | |
Creating a Job in a Specific Cluster | Used to create a data migration job in a specific CDM cluster. The job will not automatically start. | 1200 | |
Creating and Executing a Job in a Random Cluster | Used to select a random cluster in the running state from the specified clusters and create and execute a data migration job. | 120 | |
Querying a Job | Used to query the job list. | 120 | |
Modifying a Job | Used to modify the job configuration. | 120 | |
Starting a Job | Used to start a data migration job. | 1200 | |
Stopping a Job | Used to stop a running job. | 1200 | |
Querying Job Status | Used to query the running status of a job. | 120 | |
Querying Job Execution History | Used to query the historical status of job execution. | 120 | |
Deleting a job | Used to delete a job. | 120 |
DataArts Factory APIs¶
Type | Description |
|---|---|
Used to create, edit, delete, and export data connections, query the data connection list, and query data connection details. For details, see DataArts Factory > Data Management > Creating a Data Connection in the User Guide. | |
Used to delete and execute scripts. For details, see DataArts Factory > Script Development in the User Guide. | |
Used to perform operations such as deleting resources. For details, see DataArts Factory > Configuration and Management > Managing a Resource in the User Guide. | |
Used to delete jobs and query job files. For details, see DataArts Factory > Job Development in the User Guide. |