Auto Scaling
- Product Introduction
- Getting Started
- Tutorial
- Launch Configuration
- Scaling Groups
- Creating Notifications
- Expanding and Reducing Capacity
- Troubleshooting
- Practical Tutorial
- Customer Cases
- API Documentation
- Scaling Group APIs
- Launch Configuration APIs
- Making API Requests
- Scaling Group Instances APIs
- Scheduled Action APIs
- Alarm Trigger Policy APIs
- Notification APIs
- Lifecycle Hook APIs
- Instance Refresh APIs
- Other APIs
ModifyDesiredCapacity
Last updated: 2024-11-27 15:17:33
1. API Description
Domain name for API request: as.intl.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.
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: ModifyDesiredCapacity. |
| 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 | Auto scaling group ID |
| DesiredCapacity | Yes | Integer | Desired capacity |
| MinSize | No | Integer | Minimum number of instances. Value range: 0-2000. |
| MaxSize | No | Integer | Maximum number of instances. Value range: 0-2000. |
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 Modifying the desired capacity of a scaling group
Input Example
POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDesiredCapacity
<Common request parameters>
{
"AutoScalingGroupId": "asg-nvnlpbb8",
"DesiredCapacity": "2"
}
Output Example
{
"Response": {
"RequestId": "2f7c0f11-edfd-4598-a5f6-fb5c10cc9d8e"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError | An internal error occurred. |
| InvalidParameter.ActionNotFound | Invalid Action request. |
| InvalidParameterValue.AssertDesiredCapacityFailed | The declared original expected instance number does not match the actual original expected instance number. |
| InvalidParameterValue.BaseCapacityTooLarge | The specified base capacity cannot exceed the max capacity. |
| InvalidParameterValue.InvalidAutoScalingGroupId | Invalid scaling group ID. |
| InvalidParameterValue.Range | The value is outside the specified range. |
| 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.AutoScalingGroupNotFound | The scaling group does not exist. |
| ResourceUnavailable.AutoScalingGroupAbnormalStatus | The auto scaling group is exceptional. |
| ResourceUnavailable.AutoScalingGroupDisabled | The auto scaling group is disabled. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No