Product Introduction

Overview

Strengths

Scenarios

Service Limits

Access Management

Purchase Guide

Getting Started

Creating a Scaling Plan in 5 Minutes

Step 1:Creating a Launch Configuration

Step 2:Creating a Scaling Group

Step 3:Creating a Scaling Policy

Tutorial

Creating Web Services

Creating High-performance Computing Cluster

Creating Servers for Sending Requests

Configuring For High Availability Services

Launch Configuration

Launch Configuration Overview

Creating a Launch Configuration

Viewing Launch Configuration List

Modifying Launch Configurations

Exception Detection

Scaling Groups

Scaling Group Overview

Creating a Scaling Group

Viewing Scaling Group List

Modifying Scaling Groups

Modifying Bound Instances

Adding CLBs

Delete scaling group

Creating Notifications

Creating Scaling Activity Notifications

Specifying Notification Recipients

Expanding and Reducing Capacity

Auto Scaling Lifecycle Hook

Managing Scheduled Actions

Managing an Alarm-triggered Policy

Instance Health Check

Expanding Capacity Manually

Scale-in Process

Viewing Scaling Activities

Suspending and Resuming Scaling

Scale-in Removal Protection

Scaling Activity Cancelled

Scaling Activity Failed

Cooldown Period

Monitoring

Monitor Alarm Metrics

Running Status Check

Scheduled Task

Scheduled Task Execution Time Description

Troubleshooting

Scaling Group Doesn't Work

Scaling Activity Failed

Use Cases

Setting a Fixed Outbound IP Address for Scaling Groups

Deploying Elastic Web Application Service

Enabling Services Upon CVM Start-up

Customer Cases

iCarbonX

API Documentation

History

Introduction

API Category

Making API Requests

Scaling Group APIs

Scaling Group Instances APIs

Launch Configuration APIs

Scheduled Action APIs

Alarm Trigger Policy APIs

Notification APIs

Lifecycle Hook APIs

Instance Refresh APIs

Other APIs

Data Types

Error Codes

FAQs

Glossary

StartInstanceRefresh

PDF

Modo Foco

Tamanho da Fonte

Última atualização: 2025-10-30 21:28:26

1. API Description

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

This API is used to refresh running CVM instances in the scaling group and return the RefreshActivityId for the instance refresh activity based on parameters in the launch configuration.

For refresh methods involving reinstallation (currently only reinstallation is supported), during reinstallation, only the ImageId, UserData, EnhancedService, HostName, and LoginSettings parameters will be fetched from the launch configuration for refreshing; other parameters of the instance will not be refreshed.
During the instance refresh process (including paused status), the scaling group will be disabled. It is not recommended to modify the associated launch configuration during a refresh, as this may impact the refresh parameters, leading to inconsistent instance configurations.
In rolling update mode, instance refreshes are performed in multiple batches. If there are failed refreshes within a batch, the activity will enter a failed paused status.
Instances pending refresh that are removed or destroyed will be marked as NOT_FOUND status, but they will not block the instance refresh activity.
Even if a running instance has parameters consistent with the latest launch configuration, it can still undergo another refresh.

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: StartInstanceRefresh.
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.
RefreshSettings	Yes	RefreshSettings	Refresh settings.
RefreshMode	No	String	Refresh mode. default value: ROLLING_UPDATE_RESET. valid values:. ROLLING_UPDATE_RESET: reinstall the system for rolling updates. . ROLLING_UPDATE_REPLACE: Create an instance and replace the old instance with it for rolling updates. This mode does not support the rollback API currently.

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 Refresh Instance in Rolling Update Manner

Divide the instances in the scaling group asg-9dn1a5y6 into 3 batches for rolling updates, with an automatic pause between batches.

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",
    "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.
InvalidParameterValue.MaxSurgeTooLarge	The maximum additional quantity is too large.
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.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.

Ajuda e Suporte

Esta página foi útil?

Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.

comentários

tencent cloud

Auto Scaling