释放云主机
接口功能介绍
释放云主机,对于包周期的云主机为退订,对于按量付费的云主机为删除。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
释放前请确保文件已进行备份,释放后不可恢复。在云主机订购时,一起订购的其他资源,比如绑定的网卡、云硬盘、弹性IP等资源,会一起被释放。非一起订购的资源,比如绑定的网卡、云硬盘、弹性IP等资源会被解绑。
接口约束
1.云主机必须存在
2.释放云主机前请先检查云主机是否绑定虚拟IP,如果有请先解绑虚拟IP与弹性云主机
3.请检查云主机是否存在快照,如果存在快照不允许释放云主机
4.云主机处于关机(stopped)或节省关机(shelve)状态下才可释放
URI
POST /v4/ecs/unsubscribe-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,其他请求参数相同时,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | 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 | 81f7728662dd11ec810800155d307d5b |
请求示例
请求头header
无
请求体body
示例:释放一台包周期的云主机
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "755a72c6-ea40-ce04-7ad8-c9f54d38ccfd",
"clientToken": "502447b1-f894-44ae-ad0d-401bbfb4a134"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20221003143811344647",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "da70fae266a9422493d3dff51b0cd319"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码说明:
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsFormat.FormatError | 查询云主机信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机信息失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsSnapshotWorkorder.AccessFailed | 查询云主机快照失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.VipExisted | 云主机存在vip,不允许该操作 |
Ecs.Instance.SnapShotExisted | 云主机存在快照,不允许该操作 |
Ecs.Instance.OrderInfoNotExists | 查不到实例的订单信息,请确认 |
Openapi.Workorder.AccessFailed | 资源订单信息数据异常,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.StatusExpired | 当前云主机已过期,请确认云主机状态 |
Ecs.Instance.StatusFreeze | 当前云主机已冻结,请确认云主机状态 |
Ecs.Instance.StatusNotValid | 只有关机或节省关机状态才可以进行此操作,请确认云主机状态 |
Ecs.Instance.CustomerNotSupport | 预付费用户不支持自动审批退订,请确认用户信息 |
Ecs.Instance.DelZabbixError | 删除云主机自定义监控异常,请联系管理员 |
Ecs.Order.AccessFailed | 访问订单系统失败 |
Ecs.Order.ProcFailed | 订单处理失败 |
Ecs.Instance.NotSupportDeletion | 已开启实例删除保护的云主机不允许直接删除,请先关闭实例删除保护 |