All Products
Search
Document Center

:AbortAndRollbackChangeOrder

Last Updated:Dec 05, 2024

Terminates a change order and rolls back the corresponding application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:AbortAndRollbackChangeOrder
*All Resources
*
    none
none

Request syntax

PUT /pop/v1/sam/changeorder/AbortAndRollbackChangeOrder HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ChangeOrderIdstringYes

The ID of the request.

ba386059-69b1-4e65-b1e5-0682d9fa****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The returned message.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The ID of the trace. It is used to query the details of a request.

success
TraceIdstring

The details of the change order.

0a98a02315955564772843261e****
Dataobject

The ID of the change order.

ChangeOrderIdstring

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
ba386059-69b1-4e65-b1e5-0682d9fa****
ErrorCodestring

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request was invalid.
  • 5xx: indicates that a server error occurred.
success
Codestring

Indicates whether the change order was terminated or the application was rolled back. Valid values:

  • true: The change order was terminated or the application was rolled back.
  • false: The change order could not be terminated or the application could not be rolled back.
200

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ChangeOrderId": "ba386059-69b1-4e65-b1e5-0682d9fa****"
  },
  "ErrorCode": "success",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.NotEmptyYou must specify the parameter %s.-
400Resouce.no.permissionYou are not authorized to operate on the specified resources.You are not authorized to operate on the specified resources.
400InvalidChangeOrder.NotFoundThe current change order does not exist.The current change order does not exist.
400Application.ChangerOrder.Not.RunningThe change order is not running and cannot be terminated.The change order is not running and cannot be terminated.
400System.UpgradingThe system is being upgraded. Please try again later.-
400Application.ChangerOrderRunningAn application change process is in progress. Please try again later.An application change process is in progress. Please try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history