/ 弹性云服务器 ecs/ api参考/ api/ 生命周期管理/ 删除云服务器
更新时间：2023-07-27 gmt 08:00
查看pdf

删除云服务器-九游平台

功能介绍

根据指定的云服务器id列表，删除云服务器。

本接口为异步接口，当前删除云服务器请求下发成功后会返回job_id，此时删除云服务器并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当job状态为 success 时代表云服务器删除成功。

系统支持删除单台云服务器和批量删除多台云服务器操作，批量删除云服务器时，一次最多可以删除1000台。

仅支持删除按需计费的云服务器。

调试

您可以在中调试该接口。

uri

post /v1/{project_id}/cloudservers/delete

参数说明请参见表1。
表1 参数说明

参数

是否必选

描述

project_id

是

项目id。

获取方法请参见获取项目id。

请求消息

请求参数如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

servers

是

array of objects

所需要删除的云服务器列表，详情请参见表3。

delete_publicip

否

boolean

配置删除云服务器是否删除云服务器绑定的弹性公网ip。如果选择不删除，则系统仅做解绑定操作，保留弹性公网ip资源。

取值为true或false。

  • true：删除云服务器时，无论挂载在云服务器上的弹性公网ip的delete_on_termination字段为true或false，都会同时删除该弹性公网ip。
  • false：删除云服务器时，无论挂载在云服务器上的弹性公网ip的delete_on_termination字段为true或false，仅做解绑操作，不删除该弹性公网ip。
说明：

若未设置delete_publicip参数，弹性公网ip是否随实例释放依赖于该弹性公网ip的delete_on_termination字段。

  • delete_on_termination为true，delete_public为null，该弹性公网ip会被删除。
  • delete_on_termination为false，delete_public为null，该弹性公网ip仅做解绑操作，不会被删除。

delete_volume

否

boolean

配置删除云服务器是否删除云服务器对应的数据盘，如果选择不删除，则系统仅做卸载操作，保留云硬盘资源。默认为false。

  • true：删除云服务器时会同时删除挂载在云服务器上的数据盘。
  • false：删除云服务器时，仅卸载云服务器上挂载的数据盘，不删除该数据盘。
表3 servers字段数据结构说明

参数

是否必选

参数类型

描述

id

是

string

需要删除的云服务器id。

响应消息

请参考。

请求示例

删除id为“616fb98f-46ca-475e-917e-2563e5a8cd19”的云服务器，并解绑弹性公网ip、卸载数据盘。 
post https://{endpoint}/v1/{project_id}/cloudservers/delete
{
    "servers": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
        }
    ], 
    "delete_publicip": false, 
    "delete_volume": false
   }

响应示例

{
    "job_id": "ff80808288d415d80189901d8eb81cbb"
}

或

{
    "error": {
        "message": "request body is illegal.", 
        "code": "ecs.0005"
    }
}

返回值

请参考通用请求返回值。

错误码

请参考。

父主题： 生命周期管理

相关文档

网站地图