tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ResumeInstanceRefresh

Last updated: 2024-11-08 16:02:40

1. API Description

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

This API is used to resume the paused instance refresh activity, allowing it to retry failed instances in the current batch or proceed with refreshing subsequent batches. Note that calling this API is ineffective when the activity is not in a paused status.

  • When the MaxSurge parameter is used, the activity may be paused due to scale-out or scale-in failures. This API can also be used to retry scaling operations.

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: ResumeInstanceRefresh.
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.
RefreshActivityId Yes String Refresh activity ID.
ResumeMode No String Recovery mode of instances that have failed to be refreshed in the current batch. If there are no failed instances, this parameter is invalid. Default value: RETRY. Valid values:
  • RETRY: Retry instances that have failed to be refreshed in the current batch.
  • CONTINUE: Skip instances that have failed to be refreshed in the current batch.
    		•

    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 Resuming Instance Refresh Activity

    This example shows you how to resume the instance refresh activity asr-juhf6ytr in the scaling group asg-h7tgd87d to retry refreshing the failed instances in the current batch.

    Input Example

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResumeInstanceRefresh
<Common request parameters>
{
    "AutoScalingGroupId": "asg-h7tgd87d",
    "RefreshActivityId": "img-juhf6ytr",
    "ResumeMode": "RETRY"
}

    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

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