功能介绍
本接口为异步接口,当前删除云服务器请求下发成功后会返回job_id,此时删除云服务器并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当Job状态为 SUC CES S 时代表云服务器删除成功。
系统支持删除单台云服务器和批量删除多台云服务器操作,批量删除云服务器时,一次最多可以删除1000台。
仅支持删除按需计费的云服务器。
调试
您可以在API Explorer中调试该接口。
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
servers |
是 |
Array of objects |
|
delete_publicip |
否 |
Boolean |
配置删除云服务器是否删除云服务器绑定的 弹性公网IP 。如果选择不删除,则系统仅做解绑定操作,保留弹性 公网IP 资源。 取值为true或false。
说明:
若未设置delete_publicip参数,弹性公网IP是否随实例释放依赖于该弹性公网IP的delete_on_termination字段。
|
delete_volume |
否 |
Boolean |
配置删除云服务器是否删除云服务器对应的数据盘,如果选择不删除,则系统仅做卸载操作,保留 云硬盘 资源。默认为false。
|
响应消息
请参考响应(任务类)。
请求示例
POST https://{endpoint}/v1/{project_id}/cloudservers/delete { "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" } ], "delete_publicip": false, "delete_volume": false }
响应示例
{ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" }
或
{ "error": { "message": "request body is illegal.", "code": "Ecs.0005" } }
返回值
请参考通用请求返回值。
错误码
请参考错误码。