StopInstanceRefresh

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

StopInstanceRefresh

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

1. API Description

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

This API is used to pause the ongoing instance refresh activity.

In the paused status, the scaling group will also be disabled.
The instances that are currently being updated or scaled out will not be paused, but instances pending updates will have their updates paused.
During scale-in, all instances have already been updated and cannot be paused.

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: StopInstanceRefresh.
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. . Get the scaling group ID by calling the api DescribeAutoScalingGroups and retrieving the AutoScalingGroupId from the returned information. .
RefreshActivityId	Yes	String	Refresh activity ID. you can call the api DescribeRefreshActivities and obtain the instance refresh activity ID 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 Suspending the Instance Refresh Activity

Pause the instance refresh activity asr-juhf6ytr for the scaling group asg-h7tgd87d

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopInstanceRefresh
<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