tencent cloud

Feedback

ScaleOutInstances

Last updated: 2022-01-18 11:13:30

1. API Description

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

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

  • The scaling group is not active.
  • The desired capacity will be increased accordingly. The new desired capacity should be no more than the maximum capacity.
  • If the scale-out activity failed or partially succeeded, the final desired capacity only includes the instances that have been added successfully.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ScaleOutInstances.
Version Yes String Common parameter. The value used for this API: 2018-04-19.
Region Yes String Common parameter. 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 This example shows you how to add one instance to the scaling group

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