This topic describes the StartProject API provided by OceanBase Migration Service (OMS) Community Edition.
Purpose
You can call this operation to start a data migration or synchronization project.
Call description
Limitations
This operation is applicable to OMS Community Edition V4.1.1 and later versions.
Request path
POST /api/v2?Action=StartProject
Request parameters
Parameter |
Type |
Description |
|---|---|---|
| id | string | The ID of the data migration or synchronization project. |
Return result
Parameter |
Type |
Description |
|---|---|---|
| success | boolean | Indicates whether the call is successful. |
| errorDetail | object | The error details. |
| code | string | The error code. The value is null if the call succeeded, and it is a specific value if the call failed. |
| message | string | The error description. The value is null if the call succeeded, and it is a specific value if the call failed. |
| advice | string | The suggestions about how to resolve the error. |
| requestId | string | The request ID. |
| pageNumber | integer | The number of the page to return. |
| pageSize | integer | The number of entries to return on each page. |
| totalCount | integer | The total number of entries returned. |
| cost | string | The time spent in processing the request, in seconds. |
| data | - | The return result is empty. |
Examples
Sample request
{
"id":"np_4w3a****"
}
Sample response
{
"success":true,
"errorDetail":null,
"code":null,
"message":null,
"advice":null,
"requestId":"4717481****",
"pageNumber":null,
"pageSize":null,
"totalCount":null,
"cost":"10 ms",
"data":null
}