DeleteProject

2026-01-20 07:59:22  Updated

This topic describes the DeleteProject API provided by OceanBase Migration Service (OMS).

Purpose

You can call this operation to delete a data migration, synchronization, or verification task.

Call description

Limitations

This operation is supported in OMS V4.1.0 and later.

Request path

POST /api/v2?Action=DeleteProject

Request parameters

Parameter Type Description
id string The ID of the data migration, synchronization, or verification 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 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

Request example

{
    "id":"np_4w3a****"
}

Response example

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"4717481****",
    "pageNumber":null,
    "pageSize":null,
    "totalCount":null,
    "cost":"10 ms",
    "data":null
}

Contact Us