ModifyDesiredCapacity

Last updated: 2019-12-05 14:04:24

PDF

1. API Description

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

This API (ModifyDesiredCapacity) is used to modify the desired number of instances in the specified auto scaling group.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyDesiredCapacity
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 Auto scaling group ID
DesiredCapacity Yes Integer Desired capacity

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the Desired Number of Instances in an Auto Scaling Group

Input Example

https://as.tencentcloudapi.com/?Action=ModifyDesiredCapacity
&AutoScalingGroupId=asg-nvnlpbb8
&DesiredCapacity=2
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "2f7c0f11-edfd-4598-a5f6-fb5c10cc9d8e"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError Internal error.
InvalidParameterValue.Size The value of maximum, minimum, or desired number of instances in the auto scaling group is invalid.
LimitExceeded.DesiredCapacityLimitExceeded The desired number of instances exceeds the limit.
ResourceNotFound.AutoScalingGroupIdNotFound The auto scaling group does not exist.
ResourceUnavailable.AutoScalingGroupAbnormalStatus The auto scaling group is exceptional.
ResourceUnavailable.AutoScalingGroupDisabled The auto scaling group is disabled.