Rolls back an application.

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 the common request header. For more information, see Common request parameters.

Request syntax

POST /pop/v5/changeorder/co_rollback HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
AppId String Query Yes 3616cdca-4f92-4413-************

The ID of the application that you want to roll back. You can call the ListApplication operation to query the application ID. For more information, see ListApplication.

GroupId String Query Yes 8123db90-880f-48***************

The ID of the instance group where you want to roll back the application. You can call the ListDeployGroup operation to query the group ID. For more information, see ListDeployGroup.

<note>If you need to roll back the application in all instance groups, set this parameter to all. </note>

HistoryVersion String Query Yes 2019-11-13 14:22:22

The historical version to which you want to roll back the application. Call the ListHistoryDeployVersion operation to query the historical versions of the application. Then, set this parameter based on the returned value of PackageVersion. For more information, see ListHistoryDeployVersion.

Batch Integer Query No 1

The number of batches of instances on which you want to roll back the application. Valid values: 1 to 5. Default value: 1.

BatchWaitTime Integer Query No 0

The wait time between batches. Valid values: 0 to 5. Default value: 0. Unit: minutes. The value 0 indicates no wait time.

Response parameters

Parameter Type Example Description
ChangeOrderId String 921026b8-d1be-************

The ID of the change process. You can call the GetChangeOrderInfo operation to query the progress of this rollback operation. For more information, see GetChangeOrderInfo.

Code Integer 200

The HTTP status code.

Message String success

The returned message.

RequestId String D16979DC-4D42-*********

The ID of the request.

Examples

Sample requests

POST /pop/v5/changeorder/co_rollback HTTP/1.1
Common request header
{
"AppId": "3616cdca-4f92-4413-************",
"GroupId": "8123db90-880f-48***************",
"HistoryVersion": "2019-11-13 14:22:22"
}

Sample success responses

XML format

<RequestId>D16979DC-4D42-*********</RequestId>
<Message>success</Message>
<ChangeOrderId>921026b8-d1be-************</ChangeOrderId>
<Code>200</Code>

JSON format

{
    "RequestId": "D16979DC-4D42-*********",
    "Message": "success",
    "ChangeOrderId": "921026b8-d1be-************",
    "Code": 200
}

Error codes

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