API文档
云服务器相关接口
实例相关接口
关闭云服务器

1. 关闭云服务器

本接口用于关机一台云服务器。

  1. 只有状态为 Running 的云服务器才可以进行此操作。
  2. 接口调用成功后,云服务器会进入到 Stopping 状态;关闭云服务器成功后,云服务器会进入 Stopped 状态。
  3. 支持强制关闭。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。
  4. 本接口暂未支持批量操作。
  5. 本接口支持三种关机类型。分别是【节省模式关机】、【正常模式关机】和【计费模式关机】
  6. 本接口为异步接口。当创建云服务器请求下发成功后会返回一个任务进度信息(jobUuid)。通过 jobUuid 可以查询出当前异步任务执行情况。如果异步任务正在执行,返回的内容里 done=false、success=false,并有进度值显示;如果异步任务执行成功完成,返回的内容里 done=true、success=true;如果异步任务执行失败,返回的内容里 done=true,success=false。

1.1. 接口说明

本接口所属服务类型为 ecs

本接口操作类型为 StopInstances

1.1.1. 请求路径

POST {baseUrl}/v3/ecs/StopInstances

1.1.2. 请求体

{
  "zoneCode": "cn-zhongwei-a",
  "ecsUuids": ["1d393df7-5ef0-4123-bf44-d2f953efae5e"],
  "stopType": "SOFT",
  "stoppedMode":"STOP_CHARGING",
  "releaseEip": false
}

请求体内容说明

属性名属性类型是否必须默认值说明
zoneCodeString可用区编码
ecsUuidsArray需要关闭的云服务器列表
stopTypeStringSOFT云服务器关闭模式。取值范围 HARD、SOFT。默认为 SOFT
stoppedModeStringSTOP_CHARGING云服务器关机计费模式。取值范围 KEEP_CHARGING、STOP_CHARGING。按需云服务器默认为关机不计费 STOP_CHARGING;包月云服务器只支持关机计费KEEP_CHARGING
releaseEipBooleanfalse按需云服务器是否开启节省模式关机,开启后关机会释放弹性公网 IP 资源。包月云服务器不支持此参数,默认不释放弹性公网IP资源
⚠️

stopType的HARD关机模式类似直接掉电关机,这种方式可能会损坏云服务器的云盘操作系统

请谨慎选择

注意

  1. 按需计费的云服务器支持关机计费模式KEEP_CHARGING和关机不计费模式STOP_CHARGING
  2. 包月计费的云服务器只支持关机计费模式KEEP_CHARGING

关机计费模式在云服务器关机后不会释放 CPU、内存资源,不会出现由于资源不足导致的无法开机的情况

关机不计费模式在云服务器关机后会释放 CPU、内存资源,在资源不足的情况下会出现无法开机的情况

⚠️

只有按需云服务器关机不计费模式才支持开启节省模式关机。

1.1.3. 返回内容

{
  "code": 200,
  "message": "关机成功",
  "data": [
    {
      "jobUuid": "80a5811feff64ccababe69e2914d3c94",
      "success": false,
      "progress": 0.0,
      "type": "StopECS",
      "done": false,
      "resourceUuid": "1d393df7-5ef0-4123-bf44-d2f953efae5e"
    }
  ]
}

返回内容说明

属性名属性类型说明
codeInteger返回码。正常返回 200,异常返回500或其他业务错误码
messageString返回信息
dataArray异步任务进度信息

异步任务进度信息

属性名属性类型说明
jobUuidString异步任务唯一编码
successBoolean异步任务是否执行成功
progressDouble异步任务执行进度。0-100%
typeString异步任务类型
doneBoolean异步任务是否执行完成
resourceUuidString异步任务所处理的资源 Uuid