This topic describes the API operations supported by OceanBase Migration Service (OMS) and the authentication method for API requests.
API operations
| Operation | Description |
|---|---|
| CreateProject | Creates a data migration or synchronization task. |
| StartProject | Starts a data migration or synchronization task. |
| StopProject | Stops a data migration or synchronization task. |
| ResumeProject | Resumes a data migration or synchronization task. |
| ReleaseProject | Releases a data migration or synchronization task. |
| DeleteProject | Deletes a data migration or synchronization task. |
| ListProjects | Queries data migration or synchronization tasks. |
| DescribeProject | Queries the details about a data migration or synchronization task. |
| DescribeProjectSteps | Queries the steps of a data migration or synchronization task. |
| DescribeProjectStepMetric | Queries the metrics corresponding to the steps of a data migration or synchronization task. |
| DescribeProjectProgress | Queries the progress of a data migration or synchronization task. |
| DescribeProjectComponents | Queries the components of a data migration or synchronization task. |
| ListProjectFullVerifyResult | Queries the full verification results of a data migration task. |
| StartProjectsByLabel | Starts all data migration or synchronization tasks in the Not Started state with the specified label. |
| StopProjectsByLabel | Stops all data migration or synchronization tasks in the Running state with the specified label. |
| CreateMysqlDataSource | Creates a MySQL data source. |
| CreateOceanBaseDataSource | Creates an OceanBase data source. |
| ListDataSource | Queries created data sources. |
| CreateLabel | Creates a label. |
| ListAllLabels | Queries created labels. |
| ListFullVerifyInconsistenciesResult | Queries the inconsistency information about the specified object. |
| ListFullVerifyCorrectionsResult | Queries the SQL statements used for revision based on the full verification results of the specified object. |
| UpdateStore | Updates a Store component. |
| UpdateFullImport | Updates a Full-Import component. |
| UpdateIncrSync | Updates an Incr-Sync component. |
| UpdateFullVerification | Updates a Full-Verification component. |
Authentication method
You can call API operations by using the curl tool. In the following example, the CreateProject operation of OMS is accessed from the IP address xxx.xxx.xxx.1 through port 8089. YWRtaW46cm9vdA== is a Base64-encoded string of username:password.
curl "http://xxx.xxx.xxx.1:8089/api/v2?Action=CreateProject" \
-H "Authorization: Basic YWRtaW46cm9vdA=="
-H 'Content-Type: application/json'
