StartInstances

Last updated: 2021-10-27 15:54:32

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.

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 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 up instances with the specified IDs

This example shows you how to start up two shutdown instances at once.

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

SDK

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

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
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 Incorrect parameter value.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
MissingParameter Missing parameter.
MutexOperation.TaskRunning An identical job is running.
OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
UnsupportedOperation.InstanceStateCorrupted The instances are permanently corrupted, and this operation is not supported.
UnsupportedOperation.InstanceStateEnterRescueMode Instances are entering the rescue mode, and this operation is not supported.
UnsupportedOperation.InstanceStateExitRescueMode Instances are exiting from the rescue mode, and this operation is not supported.
UnsupportedOperation.InstanceStateIsolating Unable to isolate: the instance is isolated
UnsupportedOperation.InstanceStatePending The instances are being created, and this operation is not supported.
UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
UnsupportedOperation.InstanceStateRescueMode Instances in the rescue mode are not available for this operation.
UnsupportedOperation.InstanceStateRunning Running instances do not support this operation.
UnsupportedOperation.InstanceStateServiceLiveMigrate The instances are being migrated, and this operation is not supported.
UnsupportedOperation.InstanceStateShutdown Isolated instances do not support this operation.
UnsupportedOperation.InstanceStateStarting The instance is starting up, and this operation is not supported.
UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
UnsupportedOperation.InstanceStateTerminated Terminated instances are not supported.
UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.