CancelInstanceRefresh

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

CancelInstanceRefresh

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

1. API Description

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

This API is used to cancel the instance refresh activity of the scaling group.

The batches that have already been refreshed remain unaffected, but the batches pending refresh will be canceled.
If a batch is currently refreshing, cancellation is not allowed. You can suspend the event and wait until the current batch finishes before canceling.
This API is used to refresh the failed instances. If a refresh fails, the affected instances will remain in standby status, and require manual intervention to exit the standby status or terminate the instances.
Rollback operations are not allowed after cancellation, and recovery is unsupported.
Temporarily expanded instances due to the maxSurge parameter are automatically destroyed after cancellation.
During scale-in, all instances have already been updated and cannot be canceled.

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: CancelInstanceRefresh.
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. obtain available scaling group ids in the following ways:. Query the scaling group ID by logging in to the console. . Specifies the scaling group ID obtained by calling the api DescribeAutoScalingGroups and retrieving the AutoScalingGroupId from the return information. .
RefreshActivityId	Yes	String	Refresh activity ID. you can obtain the instance refresh activity ID by calling the api DescribeRefreshActivities and retrieving the RefreshActivityId from the returned information.

3. Output Parameters

Parameter Name	Type	Description
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 Canceling the Instance Refresh Activity

This example shows you how to cancel the instance refresh activity asr-juhf6ytr in scaling group asg-h7tgd87d.

Input Example

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

{
    "AutoScalingGroupId": "asg-h7tgd87d",
    "RefreshActivityId": "asr-juhf6ytr"
}

Output Example

{
    "Response": {
        "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
ResourceNotFound.RefreshActivityNotFound	The specified instance refresh activity does not exist.
ResourceUnavailable.RefreshActivityStatusConflictWithOperation	The instance refresh activity status conflicts with the current operation.
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