This API cancels a modification by its record ID.
Operation description
Only modification records in the PENDING state can be canceled.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
oceanbase:CancelProjectModifyRecord |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
string |
Yes |
The ID of the modification record. |
344000005 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| Success |
boolean |
Whether the request succeeded. |
true |
| ErrorDetail |
object |
The error details. |
|
| Code |
string |
The error code. |
200 |
| Level |
string |
The error level. Valid values: |
ERROR |
| Message |
string |
The error message. |
A system error occurred. |
| ExtraContext |
object |
Contains values for the placeholders in the |
|
|
any |
The value for a placeholder. |
null |
|
| MessageMcmsKey |
string |
The key for the error message template. |
null |
| MessageMcmsContext |
object |
Contains values for the placeholders in the template specified by |
|
|
string |
The value for a placeholder. |
null |
|
| Reason |
string |
The cause of the error. |
null |
| ReasonMcmsKey |
string |
The key for the error reason template. |
null |
| ReasonMcmsContext |
object |
Contains values for the placeholders in the template specified by |
|
|
string |
The value for a placeholder. |
null |
|
| Proposal |
string |
The recommended action. |
Contact the administrator. |
| ProposalMcmsKey |
string |
The key for the proposal template. |
null |
| ProposalMcmsContext |
object |
Contains values for the placeholders in the template specified by |
|
|
string |
The value for a placeholder. |
null |
|
| UpstreamErrorDetail |
any |
The upstream error details, used for handling HTTP requests. |
null |
| Code |
string |
The error code. This parameter is for backward compatibility. Use the |
INNER_ERROR |
| Message |
string |
The error message. This parameter is for backward compatibility. Use the |
A system error occurred. |
| Advice |
string |
A troubleshooting proposal. This parameter is for backward compatibility. Use the |
Contact the administrator. |
| RequestId |
string |
The request ID. Provide this ID when you contact technical support. |
EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C |
| PageNumber |
integer |
The page number. This parameter is returned when you use pagination. |
1 |
| PageSize |
integer |
The number of entries per page. This parameter is returned when you use pagination. |
10 |
| TotalCount |
integer |
The total number of entries. This parameter is returned when you use pagination. |
100 |
| Cost |
string |
The request duration, in seconds. |
30 |
| Data |
any |
The data returned by the request. |
null |
Examples
Success response
JSON format
{
"Success": true,
"ErrorDetail": {
"Code": "200",
"Level": "ERROR",
"Message": "A system error occurred.",
"ExtraContext": {
"key": "null"
},
"MessageMcmsKey": "null",
"MessageMcmsContext": {
"key": "null"
},
"Reason": "null",
"ReasonMcmsKey": "null",
"ReasonMcmsContext": {
"key": "null"
},
"Proposal": "Contact the administrator. ",
"ProposalMcmsKey": "null",
"ProposalMcmsContext": {
"key": "null"
},
"UpstreamErrorDetail": "null"
},
"Code": "INNER_ERROR",
"Message": "A system error occurred.",
"Advice": "Contact the administrator. ",
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Cost": "30",
"Data": "null"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.