停止实例

功能介绍

对实例进行关机。

• 调用接口前，您需要了解API 认证鉴权。
• 调用接口前，您需要了解请求Header参数说明。

接口约束

• 已停止的实例被删除后不会进入回收站。
• 停止主实例时，如果存在只读实例，会同时停止只读实例。不支持单独停止只读实例。
• 实例在以下状态不能执行停止实例：

  创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。

URI

• URI格式

  POST /v3/{project_id}/instances/{instance_id}/action/shutdown

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。

请求消息

无。

请求示例

停止实例。

POST https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/action/shutdown
{}

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  job_id	String	任务ID。

• 正常响应样例

  {
      "job_id": "2b414788a6004883a02390e2eb0ea227"
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。