tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Virtual Machine
    Documentation
    Download PDF

    RebootInstances

    Last updated: 2024-11-27 10:20:18
    Download PDF

      1. API Description

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

      This API is used to restart instances.

      • You can only perform this operation on instances whose status is RUNNING.
      • If the API is called successfully, the instance status will become REBOOTING. After the instance is restarted, its status will become RUNNING again.
      • Forced restart is supported. A forced restart is similar to switching off the power of a physical computer and starting it again. It may cause data loss or file system corruption. Be sure to only force start a CVM when it cannot be restarted normally.
      • 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 Params. The value used for this API: RebootInstances.
      Version Yes String Common Params. The value used for this API: 2017-03-12.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product.
      InstanceIds.N Yes Array of String Instance IDs. To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. You can operate up to 100 instances in each request.
      ForceReboot No Boolean Whether to forcibly restart an instance after a normal restart fails. Valid values:
    • TRUE: yes;
    • FALSE: no

      Default value: FALSE. This parameter has been disused. We recommend using StopType instead. Note that ForceReboot and StopType parameters cannot be specified at the same time.
      		•
      StopType No String Shutdown type. Valid values:
    • SOFT: soft shutdown
    • HARD: hard shutdown
    • SOFT_FIRST: perform a soft shutdown first, and perform a hard shutdown if the soft shutdown fails

      Default value: SOFT.
      		•

      3. Output Parameters

      Parameter Name Type Description
      RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

      Example1 Restarting instances

      This example shows you how to restart two instances.

      Input Example

      POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RebootInstances
<Common request parameters>

{
    "StopType": "SOFT",
    "InstanceIds": [
        "ins-5d8a23rs",
        "ins-r8hr2upy"
    ]
}

      Output Example

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

      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
      FailedOperation.InvalidInstanceApplicationRole
      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.
      InvalidParameterCombination The parameter combination is invalid.
      InvalidParameterValue Incorrect parameter value.
      InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
      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.
      UnauthorizedOperation.MFAExpired Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid.
      UnauthorizedOperation.MFANotFound Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists.
      UnsupportedOperation Unsupported operation.
      UnsupportedOperation.InstanceReinstallFailed
      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.InstanceStateEnterServiceLiveMigrate The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported.
      UnsupportedOperation.InstanceStateExitRescueMode Instances are exiting from the rescue mode, and this operation is not supported.
      UnsupportedOperation.InstanceStateExitServiceLiveMigrate The instance ins-xxxxxx in the EXIT_SERVICE_LIVE_MIGRATE status is not supported.
      UnsupportedOperation.InstanceStateFreezing The operation is not supported for the frozen instances.
      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.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.InstanceStateStopped The instance has been shut down, and this operation is not supported.
      UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
      UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
      UnsupportedOperation.StoppedModeStopCharging The instance does not support the no charges when shut down feature.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy