This topic describes the OpenAPI for OceanBase Migration Service (OMS) to advance the running of a data migration or synchronization task.
Purpose
This topic describes the OpenAPI for OceanBase Migration Service (OMS) to run an advance project.
Call description
Limitations
This API is applicable only to OMS V4.3.1 and later.
Request path
POST /api/v2?Action=AdvanceProject
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID of the data migration or synchronization task. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call is successful. |
| errorDetail | object | The error details. |
| code | string | The error code. |
| message | string | The error description. |
| advice | string | The suggestion. |
| requestId | string | The request ID. |
| pageNumber | integer | The page number. This parameter is effective only when you perform paginated query. |
| pageSize | integer | The page size. This parameter is effective only when you perform paginated query. |
| totalCount | integer | The total number of records. This parameter is effective only when you perform paginated query. |
| cost | string | The time spent in processing the request, in seconds. |
| data | string | The name of the step that is about to be advanced to the RUNNING state. |
Examples
Request example
{
"id": "np_5****"
}
Response example
{
"success": true,
"errorDetail": null,
"code": null,
"message": null,
"advice": null,
"requestId": "4717481****",
"pageNumber": null,
"pageSize": null,
"totalCount": null,
"cost": "10 ms",
"data": "TRANSFER_PRECHECK"
}
