StopInstance - 停止实例

更新时间:
复制为 MD 格式

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

接口说明

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

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

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

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:StopInstance

update

*Instance

acs:ens:*:{#accountId}:instance/{#InstanceId}

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

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

i-instanceid****

ForceStop

string

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

  • true:强制关机。

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

true

返回参数

名称

类型

描述

示例值

object

Code

integer

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

0

RequestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 MissingParameter The input parameters that is mandatory for processing this request is not supplied.
400 InstanceIdNotFound The input parameter instancdId that is not found. 指定的实例ID不存在。
400 NoPermission Permission denied.
400 CallInterface Call Interface Happen Error. 接口调用出错。
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

变更历史

更多信息,参考变更详情