StartInstances

Last Updated At: 2026-08-03 00:05:04

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (StartInstances) is used to start one or more instances.

Operation can be performed on only instances in a STOPPED state.
When the API is successfully called, the instance will enter the STARTING state. When the instance is successfully started, it will enter the RUNNING state.
Batch operations are supported. A maximum of 100 batch instances per request are allowed.

Default interface request rate limit: 10 times per second.

Interface update time: 2023-03-14 03:33:01.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name	Required	Allow NULL	Type	Description
Action	Yes	No	String	Public parameter, The value of this interface: StartInstances
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds	Yes	No	Array of String	One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the returned value from the API DescribeInstances. A maximum of 100 batch instances per request are allowed. Example: ["ins-r8hr2upy","ins-5d8a23rs"]

3. Output Parameters

Parameter name	Type	Description
TaskId	String	Task ID Example: 542324
flowId	Int64	Task Flow ID Example: 4
RequestId	String	Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code	Description
InvalidInstanceId.NotFound	No corresponding instance was found.
InvalidInstance.NotSupported	Unsupported instance.
InvalidParameterValue	Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.
InternalServerError	Internal operation error.
InvalidParameterValue.LimitExceeded	The parameter value is out of range
InvalidInstanceId.Malformed	Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error `ins-1122`.
MissingParameter	Parameters are missing. The request did not include mandatory parameters.