tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ScaleOutInstances

最后更新时间：2024-10-25 15:15:59

    1. API Description

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

    This API is used to add the specified number of instances to a scaling group. It returns the scaling activity ID ActivityId.

    • Make sure that there are no ongoing scaling tasks.
    • This API is valid even when the scaling group is disabled. For more details, see DisableAutoScalingGroup.
    • The total number of instances after this action cannot exceed the maximum capacity.
    • If a scale-out action failed or partially succeeded, only the number of successfully created instances is added to the number of desired capacity.
    • If the allocation policy is SPOT_MIXED, there may be multiple scaling activities triggered for one scaling task. In this case, the first activity ID (ActivityId) is returned.

    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: ScaleOutInstances.
    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
    ScaleOutNumber Yes Integer Number of instances to be added

    3. Output Parameters

    Parameter Name Type Description
    ActivityId String Scaling 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 This example shows you how to add one instance to the scaling group

    This example shows you how to add one instance to the scaling group asg-12yqet78.

    Input Example

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ScaleOutInstances
<Common Request Parameters>

{
    "AutoScalingGroupId": "asg-12yqet78",
    "ScaleOutNumber": 1
}

    Output Example

    {
    "Response": {
        "ActivityId": "asa-k1q8oaz6",
        "RequestId": "6af368fd-35ff-4dcc-b302-35c378f2cccb"
    }
}

    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
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
    InvalidParameterValue.Range The value is outside the specified range.
    LimitExceeded.DesiredCapacityLimitExceeded The desired number of instances exceeds the limit.
    ResourceInsufficient.AutoScalingGroupAboveMaxSize The maximum number of instances in the auto scaling group is exceeded.
    ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
    ResourceUnavailable.AutoScalingGroupInActivity The auto scaling group is active.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款