Help & DocumentationCloud Virtual Machine

RebootInstances

Last updated: 2018-10-12 16:02:34

1. API Description

Domain name for API request: cvm.tencentcloudapi.com

This API (RebootInstances) is used to restart an instance.

  • This operation is only allowed for the instances with a status of RUNNING.
  • When the API is called successfully, the instance goes into the REBOOTING status. When restarted, it goes into the RUNNING status.
  • Forced restart is supported. Just like restarting a physical PC after a power-off, a forced restart may cause data loss or the corruption of file system. Be sure to perform forced restart only when the server cannot be restarted normally.
  • Batch operations are supported. The maximum number of instances in a batch for 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: RebootInstances
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 ID(s) of one or more instances you are working with. You can obtain the parameter value from the InstanceId field value in the returned result of API DescribeInstances. A maximum of 100 instances are allowed in a batch for each request.
ForceReboot No Boolean Whether to perform a forced restart on the instance in case of a failure of normal restart. Supported values:
  • TRUE: Perform a forced restart
  • FALSE: Do not perform a forced restart

    Default: FALSE.
  • 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. Error Codes

    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 Unsupported instance.
    InvalidInstanceId.Malformed Invalid instance ID. Specified instance ID is not in a correct format. For example, ins-1122 has an invalid instance ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidParameterValue Invalid parameter value. The parameter value is in an incorrect format or is not supported.
    InvalidParameterValue.LimitExceeded Number of parameter values exceeds the limit.
    MissingParameter Parameter is missing. A required parameter is missing in the request.

    5. Example

    Example 1 Restart an instance

    Input example

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

    Output example

    {
      "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }