当ECS实例收到系统事件通知时,调用RedeployInstance可以重新部署这台实例。

接口说明

RedeployInstance为异步调用接口,会重启迁移实例。重新部署成功后,实例进入运行中(Running)状态。重新部署失败时,实例返回原有的物理服务器,并恢复到重新部署前的状态。调用该接口时,您需要注意:

  • RedeployInstance能响应以下系统事件类型,更多有关系统事件的详情,请参见系统事件
    • 待执行(Scheduled)状态下的实例重启(SystemMaintenance.Reboot)事件和实例重新部署(SystemMaintenance.Redeploy)事件。
    • 执行中(Executing)状态下的实例异常重启(SystemFailure.Reboot)事件(仅支持本地盘实例规格)。

      警告 重新部署本地盘实例会重新初始化本地盘,磁盘数据被清空。请慎重操作。
  • 目标实例必须处于运行中或者已停止状态,调用接口后的实例状态变化:
    • 处于运行中(Running)的实例会进入停止中(Stopping)状态。
    • 处于已停止(Stopped)的实例会进入启动中(Starting)状态。
  • 被安全控制的实例的OperationLocks中标记了"LockReason": "security"时,不支持重新部署。
  • 不支持重新部署专有宿主机上的实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
InstanceId String i-bp1azkttqpldxgted****

处于运行中或者已停止状态的实例ID。

Action String RedeployInstance

接口名称。对于您自行拼凑HTTP/HTTPS URL发起的API请求,Action为必选参数。取值:RedeployInstance

ForceStop Boolean false

是否强制停止运行中(Running)的实例。

默认值:false。

说明 强制停止等同于典型的服务器断电关机,实例操作系统中暂未写入磁盘的数据会丢失。建议您尽量对已停止实例做重新部署操作。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TaskId String t-bp10e8orkp********8x

重新部署的任务ID。您可以使用DescribeTasks接口查询迁移结果,以下为使用DescribeTasks时需要设置的参数示例:

  • 请参设置示例:TaskIds=["t-bp10e8or******c74o8x", "t-bp10e8orkpqm0lc74o8y"]TaskAction=RedeployInstance
  • 返参查询示例:
    • TaskStatus=Processing表示正在重新部署中
    • TaskStatus=Finished表示已完成重新部署,实例进入运行中(Running)状态
    • TaskStatus=Failed表示重新部署失败,实例返回原有的物理服务器,并恢复到重新部署前的状态。请提交工单联系阿里云技术支持

示例

请求示例

https://ecs.aliyuncs.com/?Action=RedeployInstance
&InstanceId=i-bp1azkttqpldxgted****
&<公共请求参数>

正常返回示例

XML 格式

<RedeployInstanceResponse>
      <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>
      <TaskId>t-bp10e8orkp********8x</TaskId>
</RedeployInstanceResponse>

JSON 格式

{
	"RequestId":"1C488B66-B819-4D14-8711-C4EAAA13AC01",
	"TaskId":"t-bp10e8orkp********8x"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidInstanceId.NotFound The InstanceId provided does not exist in our records. 指定的实例不存在,请您检查实例ID是否正确。
403 IncorrectInstanceStatus The current status of the resource does not support this operation. 该资源目前的状态不支持此操作。
403 InstanceLockedForSecurity The specified operation is denied as your instance is locked for security reasons. 实例被安全锁定,指定的操作无法完成。
403 DiskError IncorrectDiskStatus. 指定的磁盘状态不合法。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。如果多次尝试失败,请提交工单
403 InstanceExpiredOrInArrears The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). 包年包月实例已过期,请您续费后再进行操作。
403 IncorrectInstanceStatus %s 实例当前的状态不支持该操作。

访问错误中心查看更多错误码。