tencent cloud

Cloud Virtual Machine

동향 및 공지
제품 동향
공용 이미지 업데이트 동향
운영 체제 공식 지원 종료 계획
제품 공지
제품 소개
CVM 개요
제품 장점
기본 개념
리전 및 가용존
신규 사용자 가이드
Service Regions and Service Providers
제품 요금
요금 개요
과금 방식
과금 항목
과금 방식 변경 개요
인스턴스 구매
사양 변경 요금 설명
연체 설명
빠른 시작
사용자 정의 Linux 인스턴스 구매
사용자 정의 Windows 인스턴스 구매
사용자 가이드
운영 가이드 개요
사용 제한 개요
인스턴스
스팟 인스턴스
예약 인스턴스
이미지
스토리지
백업 및 복구
네트워크
보안
비밀번호/키
모니터링 및 알람
운영 관리
편리한 기능
서버 마이그레이션
온라인 마이그레이션
마이그레이션 요금
장애 처리
CVM에 로그인할 수 없는 문제 처리 방법
Windows 인스턴스 로그인 관련 장애
Linux 인스턴스 로그인 관련 장애
기타 인스턴스 로그인 관련 장애
인스턴스 실행 장애
Linux 인스턴스 메모리 장애
네트워크 장애
실습 튜토리얼
CVM 선택 제안
환경 구축
웹사이트 구축
애플리케이션 구축
시각화 페이지 구축
로컬 파일을 CVM에 업로드
네트워크 성능 테스트
기타 실습 튜토리얼
API 참조
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
보안 및 컴플라이언스
Cloud Access Management(CAM)
네트워크
자주 묻는 질문
리전 및 가용존 문제
요금
인스턴스 문제
스토리지 문제
이미지 관련 문제
서버 마이그레이션 관련 문제
네트워크 관련 문제
보안 관련 문제
운영 체제 관련 문제
운영 및 모니터링 관련 문제
CAM 관련 문제
NTP 서비스 관련 문제
적용 시나리오 관련 문제
Agreements
CVM Service Level Agreements
Red Hat Enterprise Linux Image Service Agreement
Public IP Service Level Agreement
용어집

RebootInstances

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-30 21:37:58

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 The applicationRole instance does not support the operation.
    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 The current instance is in a failed OS reinstallation state and does not support this operation. We recommend reinstalling the operating system again. Alternatively, you may terminate/return the instance or submit a support ticket.
    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.

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백