Tenant Cloud Compute Cloud Virtual Machine Instance APIs RebootInstances

RebootInstances

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

1. Interface Description

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

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

  • Only instances in a RUNNING state can be rebooted.
  • When the API is successfully called, the instance will enter the REBOOTING state. When the instance is successfully rebooted, the instance will enter the RUNNING state.
  • Forced reboot is supported. The effect is equivalent to turning off the switch of the physical computer and then turning on it again. Forced reboot may lead to data loss or damage of the file system. Use it only when the server cannot be normally rebooted.
  • 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: 2022-10-28 03:45:44.

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: RebootInstances
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"]
ForceReboot No No Bool Whether to choose to force reboot the instance after a normal reboot fails. Value range:
  • TRUE: Indicates a forced reboot after a normal reboot fails
  • FALSE: Indicates no forced reboot after a normal reboot fails

    Default value: FALSE. Specifying the StopType parameter at the same time is not supported.
    Example: false
    		•
    StopType No No String Shutdown type. Value range: SOFT: Indicates a soft shutdown; HARD: Indicates a hard shutdown; SOFT_FIRST: Indicates soft shutdown is prioritized, if it fails, then hard shutdown is performed. Default value: SOFT.
    Example: SOFT

    3. Output Parameters

    Parameter name Type Description
    TaskId String Task ID
    Example: 435323
    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.