tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ExitStandby

Last updated: 2024-11-27 15:17:30

1. API Description

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

This API is used to exit instances from the standby status in the scaling group.

  • When an instance is in standby status, its load balancer weight is set to 0. Upon exiting the standby status, the weight value automatically gets restored.
  • Initiating power-on/power-off actions on instances that are in standby status also results in them exiting from the standby status.

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: ExitStandby.
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.
InstanceIds.N Yes Array of String List of CVM instances in standby status.

3. Output Parameters

Parameter Name Type Description
ActivityId String Scaling activity ID.
Note: This field may return null, indicating that no valid value can be obtained.
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 Exiting Instances from Standby Status in the Scaling Group

This example shows you how to exit instances ins-osckfnm7 and ins-cri8d02t from standby status in the scaling group asg-boz1qhnk.

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExitStandby
<Common request parameters>
{
    "AutoScalingGroupId": "asg-boz1qhnk",
    "InstanceIds": [
        "ins-osckfnm7",
        "ins-cri8d02t"
    ]
}

Output Example

{
    "Response": {
        "ActivityId": "asa-q59zikez",
        "RequestId": "5b039ee6-e8ff-4605-bb24-b45337747431"
    }
}

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
FailedOperation.NoActivityToGenerate No scaling activity is generated.
InternalError An internal error occurred.
InternalError.CalleeError Exceptions occurred while invoking other services.
InternalError.RequestError An internal request error occurred.
InvalidParameter.ActionNotFound Invalid Action request.
InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
InvalidParameterValue.InvalidInstanceId Invalid instance ID.
InvalidParameterValue.LimitExceeded The value exceeds the limit.
ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
ResourceNotFound.InstancesNotFound The specified instance does not exist.
ResourceUnavailable.AutoScalingGroupInActivity The auto scaling group is active.
ResourceUnavailable.InstanceInOperation The specified instance is active.
ResourceUnavailable.LoadBalancerInOperation CLB is active in the scaling group.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy