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
AttachInstances
Last updated: 2024-11-27 15:17:31
1. API Description
Domain name for API request: as.intl.tencentcloudapi.com.
This API is used to add CVM instances to an auto scaling group.
- Only CVM instances in
RUNNINGorSTOPPEDstatus can be added. - The added CVM instances must in the same VPC as the 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: AttachInstances. |
| 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 |
| 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, 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 Adding an instance to a scaling group
Input Example
POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AttachInstances
<Common request parameters>
{
"AutoScalingGroupId": "asg-boz1qhnk",
"InstanceIds": [
"ins-osckfnm7",
"ins-cri8d02t"
]
}
Output Example
{
"Response": {
"ActivityId": "asa-q59zikez",
"RequestId": "5b039ee6-e8ff-4605-bb24-b45337747431"
}
}
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 |
|---|---|
| FailedOperation.NoActivityToGenerate | No scaling activity is generated. |
| InternalError | An internal error occurred. |
| InternalError.CalleeError | Exceptions occurred while invoking other services. |
| InternalError.RequestError | An internal request error occurred. |
| InvalidParameter.ActionNotFound | Invalid Action request. |
| InvalidParameterValue.InvalidAutoScalingGroupId | Invalid scaling group ID. |
| InvalidParameterValue.InvalidInstanceId | Invalid instance ID. |
| InvalidParameterValue.LimitExceeded | The value exceeds the limit. |
| ResourceInsufficient.AutoScalingGroupAboveMaxSize | The maximum number of instances in the auto scaling group is exceeded. |
| ResourceInsufficient.InServiceInstanceAboveMaxSize | The number of instances in a scaling group is more than the maximum capacity. |
| ResourceNotFound.AutoScalingGroupNotFound | The 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.InstanceCannotAttach | Unable to add the instance to the scaling group. |
| ResourceUnavailable.InstanceInOperation | The specified instance is active. |
| ResourceUnavailable.InstancesAlreadyInAutoScalingGroup | The instance already exists in the auto scaling group. |
| ResourceUnavailable.LoadBalancerInOperation | CLB is active in the scaling group. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No