文档

StopInstance - 停止实例

更新时间:

调用StopInstance停止运行一台实例。

接口说明

  • 只有状态为运行中(Running)的实例才可以进行此操作。

  • 成功调用接口后实例进入停止中(Stopping)状态。

  • 实例成功停止关机后进入已停止(Stopped)状态。

  • 支持强制停止,等同于断电处理,可能丢失实例操作系统中未写入磁盘的数据。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:StopInstanceupdate
  • Instance
    acs:ens:*:{#accountId}:instance/{#InstanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

要停止运行的实例的 ID,仅支持停止单个。

i-instanceid****
ForceStopstring

停止实例时是否强制关机策略。

  • true:强制关机。

  • false(默认):正常关机流程。

true

返回参数

名称类型描述示例值
object
Codeinteger

返回的业务码,正常成功为 0。

0
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.-
400InstanceIdNotFoundThe input parameter instancdId that is not found.指定的实例ID不存在。
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400CallInterfaceCall Interface Happen Error.接口调用出错。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2023-12-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情