tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

StartInstanceRefresh

Last updated: 2024-12-03 17:50:44

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. 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 Performing Instance Refresh Using the Rolling Update Method

    This example shows you how to divide the instances in the scaling group asg-9dn1a5y6 into 3 batches for rolling updates, and there will be 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",
    "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

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy