Overview
Stops a running data migration or synchronization project. Corresponds to CommonProjectController.stopProject.
API details
Constraints
The caller must have an AccessKey to access the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey Secret, see Manage AccessKeys.
Request path
POST /api/v2/oms/project/stop
Request parameters
Header
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| X-Ob-Project-Id | String | Yes | Project ID. | proj-xxxxxxxx |
| X-Ob-Org-Id | String | Yes | Organization ID. | org-xxxxxxxx |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | No | Request ID. | d04eabba-acef-4f4b-96f1-c657******** |
Body
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| id | String | Yes | Project ID. | np_7befdmp08juo |
Response parameters
Field |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request succeeded. | true |
| code | String | Error code. | "200" |
| message | String | Description | successful |
| requestId | String | Request ID. | dc302d76-66b5-48d8-ab53-a035******** |
| cost | String | Time taken. | 150 |
Examples
Request example
curl --digest -u '<your AK:SK>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/stop' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <project ID>' \
-H 'X-Ob-Org-Id: <organization ID>' \
--data '{"id":"np_7befdmp08juo"}'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"cost": "150"
}