History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Domain name for API request: as.intl.tencentcloudapi.com.
This API (ModifyAutoScalingGroup) is used to modify an auto scaling group.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyAutoScalingGroup. |
| 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. obtain available scaling group ids in the following ways: |
| AutoScalingGroupName | No | String | The scaling group name must be unique in your account. name only supports chinese, english, digits, underscore, separator "-", and decimal point. the maximum length cannot exceed 55 bytes. . |
| DefaultCooldown | No | Integer | Default cooldown in seconds, value ranges from 0 to 3600, default value is 300. . |
| DesiredCapacity | No | Integer | Expected number of instances. value range [0,2000]. to meet the maximum value equal to or greater than the expected value, and the expected value equal to or greater than the minimum value. . |
| LaunchConfigurationId | No | String | Launch configuration ID. obtain available launch configuration ids in the following ways: |
| MaxSize | No | Integer | Maximum number of instances. value range: [0,2000]. to meet the requirement, the maximum value must be equal to or greater than the expected value, and the expected value must be equal to or greater than the minimum value. . |
| MinSize | No | Integer | Minimum number of instances. value range: [0,2000]. to meet the requirement, the maximum value must be equal to or greater than the expected value, and the expected value must be equal to or greater than the minimum value. . |
| ProjectId | No | Integer | Project ID. obtain this parameter by calling the |
| SubnetIds.N | No | Array of String | subnet ID list. valid vpc subnet ids can be obtained by logging in to the console for querying. you can also call the API DescribeSubnets and retrieve them from the SubnetId field in the API response. . |
| TerminationPolicies.N | No | Array of String | Termination policy, whose maximum length is currently 1. valid values: OLDEST_INSTANCE and NEWEST_INSTANCE. |
| VpcId | No | String | vpc ID. when modifying the vpc, you need to change the SubnetIds parameter to the subnet of this vpc. effective VpcId can be queried by logging in to the console; you can also call the DescribeVpc api and get the VpcId field from the api response. . |
| Zones.N | No | Array of String | AZ list . |
| RetryPolicy | No | String | RETRY policy, whose valid values include IMMEDIATE_RETRY, INCREMENTAL_INTERVALS, and NO_RETRY, with the default value being IMMEDIATE_RETRY. a partially successful scaling operation is considered a failed activity. |
| ZonesCheckPolicy | No | String | Availability Zone validation policy. valid values include ALL and ANY. default value: ANY. it is effective when scaling group actual change resource-related fields (launch configuration, az, subnet) are modified. common causes for unavailable azs or subnets include CVM instancetype sold out in the az, CBS cloud disk sold out in the az, insufficient quota in the az, or insufficient IP addresses in the subnet. if Zones/SubnetIds contain nonexistent azs or subnets, a verification error will be reported regardless of the values of ZonesCheckPolicy. . |
| ServiceSettings | No | ServiceSettings | Service settings, including cloud monitoring and unhealthy instance replacement. . |
| Ipv6AddressCount | No | Integer | The instance has a configuration for the number of IPv6 addresses. valid values include 0 and 1. the default value is 0, which means the instance does not allocate an IPv6 address. you need to use a VPC that supports IPv6 and enable IPv6 CIDR in the subnet. |
| MultiZoneSubnetPolicy | No | String | The multi-az/subnet policy, with values including PRIORITY and EQUALITY, defaults to PRIORITY. points to consider: |
| HealthCheckType | No | String | Scaling group instance health check type, values are as follows: |
| LoadBalancerHealthCheckGracePeriod | No | Integer | Specifies the CLB health check grace period in seconds. value range: [0, 7200]. default value: 0. |
| InstanceAllocationPolicy | No | String | Instance allocation policy. valid values include LAUNCH_CONFIGURATION and SPOT_MIXED. |
| SpotMixedAllocationPolicy | No | SpotMixedAllocationPolicy | Allocation policy of instances for each billing type in SPOT hybrid mode. |
| CapacityRebalance | No | Boolean | The capacity rebalancing feature is only applicable to spot instances within the scaling group. valid values: |
| InstanceNameIndexSettings | No | InstanceNameIndexSettings | Instance name sequencing settings. once enabled, append incremental numeric sequence to the names of instances automatically created within the scaling group. . |
| HostNameIndexSettings | No | HostNameIndexSettings | Instance hostname sequencing settings. once enabled, append incremental numeric sequence to the hostname of instances automatically created within the scaling group. . |
| ConcurrentScaleOutForDesiredCapacity | No | Boolean | The concurrent scaling up functionality for matching expected numbers cannot be set when InstanceAllocationPolicy is in spot hybrid mode or when ScalingMode is in the scaling-prioritized startup mode. currently only two matching expected number scale-out activities are supported to run concurrently. other types of activities such as specified quantity scale-out or scale-in cannot be specified. set to FALSE indicates disabled. . |
| 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. |
This example shows you how to modify the VpcId and SubnetIds of the specific scaling group.
POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoScalingGroup
<Common request parameters>
{
"AutoScalingGroupId": "asg-ka0s0q80",
"SubnetIds": [
"subnet-b0vxjhot",
"subnet-3tmerl37"
],
"VpcId": "vpc-hy436tmc"
}
{
"Response": {
"RequestId": "c503ddc6-496c-44c9-8cec-e9f1c3f9c11c"
}
}
This example shows you how to modify the desired capacity of a scaling group to 3, the maximum capacity to 10, and the minimum capacity to 1.
POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoScalingGroup
<Common request parameters>
{
"AutoScalingGroupId": "asg-ka0s0q80",
"MinSize": 1,
"MaxSize": 10,
"DesiredCapacity": 3
}
{
"Response": {
"RequestId": "b41d8d30-21d4-412c-b7f3-53041879968c"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CallVpcError | VPC API call failed. |
| InternalError.RequestError | An internal request error occurred. |
| InvalidParameter.ActionNotFound | Invalid Action request. |
| InvalidParameter.Conflict | Multiple parameters specified conflict and cannot co-exist. |
| InvalidParameter.InScenario | The parameter is invalid in a specific scenario. |
| 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.CvmError | Exception with CVM parameter validation. |
| InvalidParameterValue.DuplicatedSubnet | Duplicated subnet. |
| InvalidParameterValue.GroupNameDuplicated | The auto scaling group name already exists. |
| InvalidParameterValue.InvalidAutoScalingGroupId | Invalid scaling group ID. |
| InvalidParameterValue.InvalidLaunchConfigurationId | Invalid launch configuration ID. |
| InvalidParameterValue.InvalidSubnetId | Invalid subnet ID. |
| InvalidParameterValue.LaunchConfigurationNotFound | The specified launch configuration was not found. |
| InvalidParameterValue.LbProjectInconsistent | The load balancer is in a different project. |
| InvalidParameterValue.LimitExceeded | The value exceeds the limit. |
| InvalidParameterValue.OnlyVpc | The account only supports VPCs. |
| InvalidParameterValue.ProjectIdNotFound | The project ID does not exist. |
| 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. |
| InvalidParameterValue.SubnetIds | The subnet information is invalid. |
| InvalidParameterValue.SubnetNotInDedicatedCluster | The subnet is not in the designated local dedicated cluster. |
| InvalidParameterValue.TooLong | Too many values. |
| LimitExceeded | The quota limit is exceeded. |
| LimitExceeded.MaxSizeLimitExceeded | The maximum number of instances exceeds the limit. |
| LimitExceeded.MinSizeLimitExceeded | The minimum number of instances is below the limit. |
| MissingParameter | Parameter missing. |
| MissingParameter.InScenario | A parameter is missing in a specific scenario. |
| ResourceNotFound.AutoScalingGroupNotFound | The scaling group does not exist. |
| ResourceUnavailable.ForbiddenModifyVpc | You cannot modify the VPC of a scaling group bound with a load balancer. |
| ResourceUnavailable.LaunchConfigurationStatusAbnormal | The launch configuration is exceptional. |
| ResourceUnavailable.ProjectInconsistent | Project inconsistency. |
フィードバック