停止实例

功能介绍

对实例进行关机。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

接口约束

• 该接口仅支持MySQL和PostgreSQL引擎。
• Serverless型实例不支持该接口。
• 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例，专属云RDS不支持停止实例。
• 已停止的实例被删除后不会进入回收站。
• 停止主实例时，如果存在只读实例，会同时停止只读实例。不支持单独停止只读实例。对于华东-上海一区域，主实例和只读实例均默认停止十五天。对于除华东-上海一外的其他区域，主实例和只读实例均默认停止七天。
  • 对于华东-上海一区域，实例默认停止十五天，如果您在十五天后未手动开启实例，数据库实例将于十五天后的下一个可维护时间段内自动启动。
  • 对于除华东-上海一外的其他区域，实例默认停止七天，如果您在七天后未手动开启实例，数据库实例将于七天后的下一个可维护时间段内自动启动。
• 实例停止后，虚拟机（VM）停止收费，其余资源包括弹性公网IP（EIP）、存储资源、备份正常计费。
• 按需付费的数据库实例停止实例后，可能会出现由于资源不足引起开启失败，如遇到无法开启的情况请联系客服人员处理。
• 实例在以下状态不能执行停止实例：

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

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

• 异常

  请参见状态码。

错误码

请参见错误码。