tencent cloud

Feedback

CancelInstanceRefresh

Last updated: 2024-10-25 15:17:06

1. API Description

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

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

  • Batches that have already been refreshed or are currently being refreshed remain unaffected; batches pending refresh will be canceled.
  • If a refresh fails, the affected instances will remain in the standby status and require manual intervention by the user to either attempt to exit the standby status or destroy the instances.
  • Rollback operations are not allowed after cancellation, and resuming is also unsupported.

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.
RefreshActivityId Yes String Refresh activity ID.

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.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

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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support