Overview
Terminates the specified project modification. The operation cannot be resumed. Only modification records in the RUNNING state are supported. Records in other states, including FAILED, are rejected by the preliminary state check, which returns an invalid project state exception. Corresponds to CommonModifyProjectController.stopProjectModifyRecords.
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/modifyRecord/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 |
Body
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| id | String | Yes | Modification record ID. | 123456789 |
Response parameters
Field |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request succeeded. | true |
| data | Object | Null on success. | null |
| requestId | String | Request ID. | req-xxx-xxx |
| cost | String | Time taken. | 123ms |
Examples
Request example
curl --digest -u '<your AK:SK>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/modifyRecord/stop' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <project ID>' \
-H 'X-Ob-Org-Id: <organization ID>' \
--data '{"id":"123456789"}'
Response example
{
"success": true,
"data": null,
"requestId": "req-xxx-xxx",
"cost": "123ms"
}