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 a list of data migration or synchronization tasks in pagination mode. |
| DescribeProject | Queries details about a data migration or synchronization task. |
| DescribeProjectSteps | Queries details about steps in a data migration or synchronization task. |
| DescribeProjectStepMetric | Queries metrics of steps in a data migration or synchronization task. |
| DescribeProjectProgress | Queries the progress information about a data migration or synchronization task. |
| DescribeProjectComponents | Queries information about components in a data migration or synchronization task. |
| ListProjectFullVerifyResult | Queries the full verification result of a data migration task. |
| StartProjectsByLabel | Starts all data migration or synchronization tasks in the Not Started state under the specified tag. |
| StopProjectsByLabel | Stops all data migration or synchronization tasks in the Running state under the specified tag. |
| CreateMysqlDataSource | Creates a MySQL data source. |
| CreateOceanBaseDataSource | Creates an OceanBase data source. |
| CreateOceanBaseODPDataSource | Creates an OceanBase Database Proxy (ODP) data source. |
| ListDataSource | Queries a list of created data sources. |
| CreateLabel | Creates a tag. |
| ListAllLabels | Queries a list of created tags. |
| DeleteDataSource | Deletes a data source. |
| CreateProjectModifyRecords | Adds or removes table objects. |
| ListProjectModifyRecords | Queries the modification records of a data migration or synchronization task based on the task ID. |
| StopProjectModifyRecords | Stops a modification operation based on the modification record ID. |
| RetryProjectModifyRecords | Retries a modification operation based on the modification record ID. |
| CancelProjectModifyRecord | Cancels a modification operation based on the modification record ID. |
| SubmitPreCheck | Performs a precheck on a data migration or synchronization task. |
| GetPreCheckResult | Queries the precheck result of a data migration or synchronization task. |
| UpdateProjectConfig | Updates the configurations of a data migration or synchronization task. |
| Download schema conversion information | Downloads the schema conversion information of migrated or synchronized tables after schema migration is completed. |
| DownloadConflictData | Downloads the conflict log files of a data migration or synchronization task. |
| ListConflictData | Queries the list of conflict log files of a data migration or synchronization task. |
| ResetIncrStartTimestamp | Modifies the synchronization timestamp of forward and reverse incremental synchronization. |
| AdvanceProject | Advances the running of a data migration or synchronization task. |
| DescribeRegions | Queries the list of regions of an OMS cluster. |
curl examples
You can use the curl tool to call API operations. In the following example, the access URL of OMS is xxx.xxx.xxx.1, the port is 8089, and the called operation is ListProjects. YWRtaW46cm9vdA= is the Base64-encoded value of username:password.
curl -X POST -H 'Authorization:Basic YWRtaW46cm9vdA=' -H 'Content-Type: application/json' -d '{"pageNumber":1,"pageSize":1}' http://xxx.xxx.xxx.1:8089/api/v2?Action=ListProjects
