1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (DetachInstances) is used to remove CVM instances from a scaling group. This API does not terminate instances.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-31 18:26:30.
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: DetachInstances |
| 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-boz1qhnk |
| InstanceIds | Yes | No | Array of String | IDs of CVM instances. Example: ["ins-cri8d02t\n","ins-osckfnm7\n"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ActivityId | String | ID of the scaling activity. Example: asa-bcfxhy55 |
| 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 |
|---|---|
| ResourceInsufficient.AutoScalingGroupBelowMinSize | The number of instances in the auto scaling group is below the minimum value. |
| ResourceUnavailable.AutoScalingGroupInActivity | The auto scaling group is active. |
| ResourceNotFound.AutoScalingGroupIdNotFound | The scaling group does not exist. |
| ResourceNotFound.InstancesNotInAutoScalingGroup | The target instance is not in the auto scaling group. |
| InvalidParameterValue.LimitExceeded | The value exceeds the limit. |
| InternalError | Internal error. |