Help & DocumentationCloud Virtual MachineAPI DocumentationInstance APIsStartInstances

StartInstances

Last updated: 2019-12-05 19:39:09

PDF

Contents：

1. API Description

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

This API is used to start instances.

  • You can only perform this operation on instances whose status is STOPPED.
  • The instance status will become STARTING when the API is called successfully and RUNNING when the instance is successfully started.
  • Batch operations are supported. The maximum number of instances in each request is 100.

A maximum of 10 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: cvm.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: StartInstances
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N Yes Array of String Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. The maximum number of instances in each request is 100.

3. Output Parameters

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

4. Example

Example1 Starting instances with the instance IDs specified

With this API, you can start one or more instances that have been shut down.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=StartInstances
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
  }
}

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
InternalServerError Internal error.
InvalidInstance.NotSupported This instance is not supported.
InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
InvalidInstanceId.NotFound No instance found.
InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
MissingParameter Missing parameter: a required parameter is missing.