重启实例

最近更新时间:2024-03-12 01:19:21

我的收藏

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (RebootInstances) 用于重启实例。

  • 只有状态为RUNNING的实例才可以进行此操作。
  • 接口调用成功时,实例会进入REBOOTING状态;重启实例成功时,实例会进入RUNNING状态。
  • 支持强制重启。强制重启的效果等同于关闭物理计算机的电源开关再重新启动。强制重启可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常重启时使用。
  • 支持批量操作,每次请求批量实例的上限为100。
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RebootInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过 DescribeInstances 接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
示例值:["ins-r8hr2upy","ins-5d8a23rs"]
ForceReboot Boolean 本参数已弃用,推荐使用StopType,不可以与参数StopType同时使用。表示是否在正常重启失败后选择强制重启实例。取值范围:
  • true:表示在正常重启失败后进行强制重启
  • false:表示在正常重启失败后不进行强制重启

    默认取值:false。
    示例值:false
  • StopType String 关机类型。取值范围:
  • SOFT:表示软关机
  • HARD:表示硬关机
  • SOFT_FIRST:表示优先软关机,失败再执行硬关机

    默认取值:SOFT。
    示例值:SOFT
  • 3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 重启实例

    本示例用于重启两个实例。

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: RebootInstances
    <公共请求参数>
    
    {
        "StopType": "SOFT",
        "InstanceIds": [
            "ins-5d8a23rs",
            "ins-r8hr2upy"
        ]
    }

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.InvalidInstanceApplicationRole 不支持操作的applicationRole实例
    InternalServerError 操作内部错误。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameterCombination 表示参数组合不正确。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.InstanceIdMalformed 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    MissingParameter 缺少参数错误。
    MutexOperation.TaskRunning 同样的任务正在运行。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    UnauthorizedOperation.MFAExpired 您无法进行当前操作,请确认多因子认证(MFA)是否失效。
    UnauthorizedOperation.MFANotFound 没有权限进行此操作,请确认是否存在多因子认证(MFA)。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.InstanceReinstallFailed 当前实例为重装系统失败状态,不支持此操作;推荐您再次重装系统,也可以销毁/退还实例或提交工单
    UnsupportedOperation.InstanceStateCorrupted 请求不支持永久故障的实例。
    UnsupportedOperation.InstanceStateEnterRescueMode 请求不支持进入救援模式的实例
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateExitRescueMode 请求不支持正在退出救援模式的实例
    UnsupportedOperation.InstanceStateExitServiceLiveMigrate 不支持状态为 EXIT_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateFreezing 操作不支持已冻结的实例。
    UnsupportedOperation.InstanceStateIsolating 请求不支持正在隔离状态的实例。
    UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateServiceLiveMigrate 不支持正在服务迁移的实例,请稍后再试
    UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
    UnsupportedOperation.InstanceStateStarting 实例开机中,不允许该操作。
    UnsupportedOperation.InstanceStateStopped 请求不支持已关机的实例
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性