RollbackInstanceRefresh

Last updated: 2025-10-30 21:28:27

RollbackInstanceRefresh

Last updated: 2025-10-30 21:28:27

1. API Description

Domain name for API request: as.intl.tencentcloudapi.com.

This API is used to generate a new instance refresh activity, which also supports batch refreshing and operations such as pausing, resuming, and canceling. This API returns RefreshActivityId for the rollback activity.

The instances pending refresh in the original activity are updated to canceled status. Nonexistent instances are disregarded, while instances in all other statuses proceed to enter the rollback process.
The instances that are being refreshed in the original activity will not be immediately terminated. Instead, the rollback activity will be executed after their refresh complete.
Rollback is supported for activities that are in the paused status or those succeeded in refreshing last time. It is not supported for activities in other statuses.
When the original refresh activity involves reinstalling instances, for the ImageId parameter, it will automatically recover to the image ID before the rollback; for parameters such as UserData, EnhancedService, LoginSettings, and HostName, they will still be read from the launch configuration, requiring users to manually modify the launch configuration before initiating the rollback.
The rollback activity does not support the MaxSurge parameter currently.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: RollbackInstanceRefresh.
Version	Yes	String	Common Params. The value used for this API: 2018-04-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
AutoScalingGroupId	Yes	String	Scaling group ID. you can obtain available scaling group ids in the following ways. Query the scaling group ID by logging in to the console. . Obtain the scaling group ID by calling the api DescribeAutoScalingGroups and retrieving the AutoScalingGroupId from the returned information. .
RefreshSettings	Yes	RefreshSettings	Refresh settings.
OriginRefreshActivityId	Yes	String	The original refresh activity ID. you can obtain the original refresh activity ID by calling the api DescribeRefreshActivities and retrieving the OriginRefreshActivityId from the returned information.
RefreshMode	No	String	Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.

3. Output Parameters

Parameter Name	Type	Description
RefreshActivityId	String	Refresh activity ID.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Rolling Update Method Rollback Instance Refresh Activity

Roll back the instance refresh activity asr-i8u7tytd for the scaling group asg-9dn1a5y6.

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartInstanceRefresh
<Common request parameters>

{
    "AutoScalingGroupId": "asg-9dn1a5y6",
    "RefreshMode": "ROLLING_UPDATE_RESET",
    "OriginRefreshActivityId": "asr-i8u7tytd",
    "RefreshSettings": {
        "RollingUpdateSettings": {
            "BatchNumber": 3,
            "BatchPause": "BATCH_INTERVAL_PAUSE"
        }
    }
}

Output Example

{
    "Response": {
        "RefreshActivityId": "asr-y67t5r4e",
        "RequestId": "c4190090-bc60-4f48-b9d4-48095b9596db"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameterValue.BatchNumberTooLarge	The batch count cannot exceed the total number of instances pending refresh.
ResourceNotFound.AutoScalingGroupIdNotFound	The scaling group does not exist.
ResourceUnavailable.AutoScalingGroupAbnormalStatus	The auto scaling group is exceptional.
ResourceUnavailable.AutoScalingGroupInActivity	The auto scaling group is active.
ResourceUnavailable.AutoScalingGroupInRefreshActivity	The scaling group is already involved in another instance refresh activity.
ResourceUnavailable.InquiryPriceResetInstanceFailed	The instance reinstallation quotation failed, because the new image conflicts with other parameters of the instance or the new image does not exist.
ResourceUnavailable.NoInstanceCanRefresh	There are no instances in running status within the scaling group, making it impossible to perform an instance refresh.
ResourceUnavailable.NoInstanceCanRollback	There are no instances eligible for rollback in the scaling group.
ResourceUnavailable.RefreshActivityCanNotRollback	The current refresh activity is in a successful status and not the most recent execution, so it cannot be rolled back.
ResourceUnavailable.RefreshActivityStatusConflictWithOperation	The instance refresh activity status conflicts with the current operation.
ResourceUnavailable.RollbackTypeActivityCanNotRollbackAgain	Rollback type instance refresh activity cannot be rolled back again.
UnauthorizedOperation.AutoScalingRoleUnauthorized	You have not assigned the CAM role AS-QCSRole to Auto Scaling. Please go to the AS console to complete authorization first.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud