Terminates a change order.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
ChangeOrderId String Query Yes be2e1c76-682b-4897-98d3-1d8d6478****

The ID of the change order.

Response parameters

Parameter Type Example Description
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

The ID of the request.

Message String success

The returned message.

TraceId String 0a98a02315955564772843261e****

The ID of the trace.

Data Object

The returned data.

ChangeOrderId String be2e1c76-682b-4897-98d3-1d8d6478****

The ID of the change order.

ErrorCode String This parameter is left empty.

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.
Code String 200

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 Boolean true

Indicates whether the change order was terminated. Valid values:

  • true: The change order was terminated.
  • false: The change order could not be terminated.

Examples

Sample requests

PUT /pop/v1/sam/changeorder/AbortChangeOrder?ChangeOrderId=be2e1c76-682b-4897-98d3-1d8d6478**** HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<AbortChangeOrderResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <ChangeOrderId>be2e1c76-682b-4897-98d3-1d8d6478****</ChangeOrderId>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</AbortChangeOrderResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a98a02315955564772843261e****",
  "Data" : {
    "ChangeOrderId" : "be2e1c76-682b-4897-98d3-1d8d6478****"
  },
  "Code" : "200",
  "Success" : true
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter.NotEmpty You must specify the parameter %s. The error message returned because the value of the %s parameter is invalid. This parameter cannot be left empty.
400 Resouce.no.permission You are not authorized to operate on the specified resources. The error message returned because you do not have the required permissions on the resources.
400 Application.ChangerOrder.Not.Running The change order is not running and cannot be terminated. The error message returned because the change order is not in the running state and cannot be terminated.
400 Application.ChangerOrderRunning An application change process is in progress. Please try again later. The error message returned because an application change is in progress. Try again later.

For a list of error codes, visit the API Error Center.