Cancels an upgrade. You can call this operation only if the upgrade task has not started or is in the pre_check state. You cannot cancel the upgrade after the task enters the backup state or any subsequent state.
Try it now
Test
RAM authorization
Request syntax
POST /api/v1/instances/{instanceId}/upgrade/discard HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
No |
The instance ID. |
hgprecn-cn-1wy47xsoxxxx |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID. |
cn-shenzhen |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
A47D57BE-59D1-51A6-9CC3-080C07852C4E |
| Data |
array<object> |
The returned data. |
|
|
object |
The result. |
||
| Success |
boolean |
Indicates whether the operation was successful. |
true |
| ReasonKey |
string |
The reason key. |
null |
| FailReason |
string |
The reason the upgrade failed. |
null |
| Success |
boolean |
Indicates whether the API request itself was successful. This does not reflect the outcome of the operation. For the operation's result, see the Success field in the Data array. |
true |
| ErrorCode |
string |
The error code. |
null |
| ErrorMessage |
string |
The error message. |
null |
| HttpStatusCode |
string |
The HTTP status code. |
200 |
Examples
Success response
JSON format
{
"RequestId": "A47D57BE-59D1-51A6-9CC3-080C07852C4E",
"Data": [
{
"Success": true,
"ReasonKey": "null",
"FailReason": "null"
}
],
"Success": true,
"ErrorCode": "null",
"ErrorMessage": "null",
"HttpStatusCode": "200"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.