AttachInstances

Last updated: 2019-12-05 14:10:39

PDF

1. API Description

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

This API (AttachInstances) is used to add CVM instances to an 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: AttachInstances
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
InstanceIds.N Yes Array of String List of CVM instance IDs

3. Output Parameters

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

4. Example

Example1 Adding an Instance to an Auto Scaling Group

Input Example

https://as.tencentcloudapi.com/?Action=AttachInstances
&AutoScalingGroupId=asg-boz1qhnk
&InstanceIds.0=ins-cri8d02t
&InstanceIds.1=ins-osckfnm7
&<Common request parameter>

Output Example

{
  "Response": {
    "ActivityId": "asa-q59zikez",
    "RequestId": "5b039ee6-e8ff-4605-bb24-b45337747431"
  }
}

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.LimitExceeded The value exceeds the limit.
ResourceInsufficient.AutoScalingGroupAboveMaxSize The maximum number of instances in the auto scaling group is exceeded.
ResourceNotFound.AutoScalingGroupIdNotFound The auto scaling group does not exist.
ResourceNotFound.InstancesNotFound The specified instance does not exist.
ResourceUnavailable.AutoScalingGroupInActivity The auto scaling group is active.
ResourceUnavailable.CvmVpcInconsistent The instance and the auto scaling group are in different VPCs.
ResourceUnavailable.InstancesAlreadyInAutoScalingGroup The instance already exists in the auto scaling group.