StartAutoScalingInstances

Download PDF

Last updated: 2024-11-27 15:17:28

Last updated: 2024-11-27 15:17:28

Download PDF

1. API Description

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

This API is used to start up CVM instances in a scaling group.

After startup, the instance will be in the IN_SERVICE status, which will increase the desired capacity. Please note that the desired capacity cannot exceed the maximum value.
This API supports batch operation. Up to 100 instances can be started up in each request.

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: StartAutoScalingInstances.
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	The scaling group ID.
InstanceIds.N	Yes	Array of String	The list of the CVM instances you want to start up.

3. Output Parameters

Parameter Name	Type	Description
ActivityId	String	The 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 Starting up CVM instances

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartAutoScalingInstances
<Common request parameters>

{
    "AutoScalingGroupId": "asg-boz1qhnk",
    "InstanceIds": [
        "ins-osckfnm7",
        "ins-cri8d02t"
    ]
}

Output Example

{
    "Response": {
        "ActivityId": "asa-a023dwdj",
        "RequestId": "28cf9089-2b76-4934-9d1b-b2694c679ff0"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.
InvalidParameter.ActionNotFound	Invalid Action request.
InvalidParameterValue.InvalidAutoScalingGroupId	Invalid scaling group ID.
InvalidParameterValue.InvalidInstanceId	Invalid instance ID.
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.InstancesNotInAutoScalingGroup	The target instance is not in the auto scaling group.
ResourceUnavailable.AutoScalingGroupInActivity	The auto scaling group is active.
ResourceUnavailable.InstanceInOperation	The specified instance is active.
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

tencent cloud