1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (ModifyAutoScalingGroup) is used to modify an auto scaling group.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-31 17:04:15.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyAutoScalingGroup |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-04-19 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| AutoScalingGroupId | Yes | No | String | ID of the scaling group. Example: asg-aaaabbbb |
| AutoScalingGroupName | No | No | String | Name of the scaling group. The name must be unique within your account. The name can contain only letters, digits, underscores (_), hyphens (-), and decimal points (.) and must be up to 55 bytes in length. Example: asgname |
| DefaultCooldown | No | No | Uint64 | Default cooldown period. Unit: seconds. Default value: 300. Example: 300 |
| DesiredCapacity | No | No | Uint64 | Desired number of instances. The value must be in the range of the minimum number of instances and the maximum number of instances. Example: 1 |
| LaunchConfigurationId | No | No | String | Launch Configuration ID Example: asc-aaaabbbb |
| MaxSize | No | No | Uint64 | Maximum number of instances. Valid values: 0 to 2000. Example: 1 |
| MinSize | No | No | Uint64 | Minimum number of instances. Valid values: 0 to 2000. Example: 1 |
| ProjectId | No | No | Uint64 | Project ID. Example: 1 |
| SubnetIds | No | No | Array of String | IDs of subnets. Example: ["subnet-aaaabbbb"] |
| TerminationPolicies | No | No | Array of String | Termination policy. Currently, you can specify up to one termination policy. Valid values: OLDEST_INSTANCE and NEWEST_INSTANCE. Example: ["OLDEST_INSTANCE"] |
| VpcId | No | No | String | VPC ID. Set this parameter to an empty string to specify the basic network. If you specify a VPC ID, you must also specify the SubnetIds parameter. If you specify the basic network, you also must specify the corresponding availability zones. Example: vpc-aaaabbbb |
| Zones | No | No | Array of String | List of AZ IDs. Example: ["ap-region-1"] |
| RetryPolicy | No | No | String | Retry policy. Valid values: IMMEDIATE_RETRY, INCREMENTAL_INTERVALS, and NO_RETRY. Valid value: IMMEDIATE_RETRY. Example: IMMEDIATE_RETRY |
| ZonesCheckPolicy | No | No | String | Availability zone verification policy. Valid values include ALL and ANY. Default value: ANY. This parameter takes effect when you change the resource-related settings for the scaling group (launch configuration, availability zone, and subnet) Common reasons why an AZ or subnet is unavailable include: the CVM instance types in the AZ are sold out, the CBS disks in the AZ are sold out, the quota in the AZ is insufficient, and the IP addresses in the subnet are insufficient. If the AZs specified in the Zones parameter or the subnets specified in the SubnetIds parameter do not exist, the verification fails regardless of the value of the ZonesCheckPolicy parameter. Example: ALL |
| ServiceSettings | No | No | ServiceSettings | Service settings, including unhealthy instance replacement. Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.OnlyVpc | The account only supports VPCs. |
| InvalidParameter.InScenario | The parameter is invalid in a specific scenario. |
| InvalidParameterValue.LbProjectInconsistent | The load balancer is in a different project. |
| InvalidParameterValue.Range | The value is outside the specified range. |
| InvalidParameterValue.TooLong | Too many values. |
| ResourceUnavailable.ProjectInconsistent | Project inconsistency. |
| InvalidParameterValue.GroupNameDuplicated | The auto scaling group name already exists. |
| LimitExceeded.MaxSizeLimitExceeded | The maximum number of instances exceeds the limit. |
| ResourceNotFound.AutoScalingGroupIdNotFound | The scaling group does not exist. |
| InvalidParameterValue.Size | The value of maximum, minimum, or desired number of instances in the auto scaling group is invalid. |
| MissingParameter | Parameter missing. |
| InvalidParameterValue.LbVpcInconsistent | The load balancer and the scaling group are in different VPCs. |
| LimitExceeded.MinSizeLimitExceeded | The minimum number of instances is below the limit. |
| LimitExceeded | The quota limit is exceeded. |
| InvalidParameterValue.CvmError | Exception with CVM parameter validation. |
| InvalidParameterValue.LaunchConfigurationNotFound | The specified launch configuration was not found. |
| InvalidParameterValue.SubnetIds | The subnet information is invalid. |
| MissingParameter.InScenario | A parameter is missing in a specific scenario. |
| ResourceUnavailable.LaunchConfigurationStatusAbnormal | The launch configuration is exceptional. |
| InvalidParameterValue.LimitExceeded | The value exceeds the limit. |