接口功能介绍
支持删除云主机，并选择是否释放关联资源
对于包周期的云主机为退订，最终状态会转变为包周期已退订（unsubscribed）
对于按量付费的云主机为删除，删除完成后，无法再次通过云主机相关查询接口查询到该云主机信息
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
释放前请确保文件已进行备份，释放后不可恢复。在云主机订购时，一起订购的其他资源，比如绑定的网卡、云硬盘、弹性IP等资源，会一起被释放。非一起订购的资源，比如绑定的网卡、云硬盘、弹性IP等资源会被解绑。
接口约束
1.云主机必须存在
2.释放云主机前请先检查云主机是否绑定虚拟IP，如果有请先解绑虚拟IP与弹性云主机
3.请检查云主机是否存在快照，如果存在快照不允许释放云主机
4.多可用区资源池下按量付费（onDemand为true）云主机处于关机（stopped）、节省关机（shelve）、错误（error）、运行中（running）、已冻结（freezing）、无系统盘（noBootDisk）或系统盘已到期（bootDiskExpired）状态下才可释放；其他情况云主机处于关机（stopped）、节省关机（shelve）、错误（error）、无系统盘（noBootDisk）或系统盘已到期（bootDiskExpired）状态下才可释放
5.云主机挂载的云硬盘需处于已挂载或错误状态
6.随云主机一同创建的硬盘，不可含有硬盘快照，如需释放云主机请先删除硬盘快照
7.如填写deleteVolume参数为true时，非随云主机一同创建的挂载在云主机上的云硬盘，如含有硬盘快照，只会解绑而不释放
8.如填写deleteVolume参数为true时，共享盘不会跟随释放
9.云主机不可设置释放保护
URI
POST /v4/ecs/delete-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。保留时间为24小时，使用同一个clientToken值，则代表为同一个请求 | delete-test-001 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 |
755a72c6-ea40-ce04-7ad8-c9f54d38ccfd | |
| deleteVolume | 否 | Boolean | 是否释放所挂载的数据盘，true（释放），false（不释放），默认值False。 注：不包含随主机一同创建的数据盘，随主机创建的盘默认随主机一同释放；所挂载的数据盘若含有硬盘快照，则不会释放 |
true | |
| deleteEip | 否 | Boolean | 是否释放所绑定的弹性公网ip，true（释放），false（不释放），默认值False。 注：不包含随主机一同创建的弹性公网ip，随主机创建的弹性公网ip默认随主机一同释放 |
true |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 英文描述信息 | SUCCESS | |
| description | String | 中文描述信息 | 成功 | |
| returnObj | Object | 成功时返回空 | {} |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "755a72c6-ea40-ce04-7ad8-c9f54d38ccfd",
"deleteVolume": true,
"deleteEip: true,
"clientToken": "delete-test-001"
}
响应示例
{
"returnObj": {},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
