接口功能介绍
释放云主机
接口约束
1.云主机必须存在
2.释放云主机前请先检查云主机是否绑定虚拟IP，如果有请先解绑虚拟IP与弹性云主机
3.请检查云主机是否存在快照，如果存在快照不允许释放云主机
4.云主机存在且处于关机、节省关机、错误、无系统盘、系统盘已到期状态
5.云主机已挂载的云硬盘状态处于“已挂载”或者错误状态
6.当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/unsubscribe
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。保留时间为24小时，使用同一个clientToken值，则代表为同一个请求 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 资源池ID，您可以调用查询账户启用的资源池信息查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
| azName | 否 | String | 可用区名称。您可以调用资源池可用区查询，查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空(即为单可用区，本字段填写default)。 | cn-huadong1-jsnj1A-public-ctcloud | |
| ID | 是 | String | 云主机ID | 755a72c6-ea40-ce04-7ad8-c9f54d38ccfd |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
| masterOrderNO | String | 订单号 | 20221010142913884246 | |
| regionID | String | 资源池ID | bb9fdb42056f11eda1610242ac110002 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"ID": "755a72c6-ea40-ce04-7ad8-c9f54d38ccfd",
"clientToken": "502447b1-f894-44ae-ad0d-401bbfb4a134"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20221003143811344647",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"masterOrderID": "da70fae266a9422493d3dff51b0cd319"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
