释放轻量型云主机
接口功能介绍
该接口提供用户退订一台轻量型云主机功能
接口约束
轻量云主机需要处于关机状态
URI
POST /v4/ecs/lite/unsubscribe
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
| instanceID | 是 | String | 云主机ID | 755a72c6-ea40-ce04-7ad8-c9f54d38ccfd |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | 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": "81f7728662dd11ec810800155d307d5b",
"instanceID": "755a72c6-ea40-ce04-7ad8-c9f54d38ccfd",
"clientToken": "502447b1-f894-44ae-ad0d-401bbfb4a134"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230712111010262171",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"masterOrderID": "022c6b9ea56a42af8fa7eb36957ff600"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| LiteEcs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionVersion.NotSupport | 当前API不支持该资源池，请切换资源池重试 |
| LiteEcs.UserVisibleRegions.DataDamaged | 查询用戶可见资源池信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserVisibleRegions.AccessFailed | 查询用戶可见资源池失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Parameter.InvalidRegionID | 可见资源池信息为空，请确认regionID是否正确 |
| Openapi.EcsWorkorder.AccessFailed | 查询云主机失败，请重试。如果多次尝试失败，请提交工单 |
| Openapi.EcsFormat.FormatError | 查询云主机信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.NotFound | 云主机不存在，请确认云主机ID是否有效 |
| Openapi.EcsCheck.UnknownError | 云主机检查失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.OrderInfoNotExists | 查不到实例的订单信息，请确认 |
| Openapi.Workorder.AccessFailed | 资源订单信息数据异常，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.StatusExpired | 当前云主机已过期，请确认云主机状态 |
| LiteEcs.Instance.StatusFreeze | 当前云主机已冻结，请确认云主机状态 |
| LiteEcs.Instance.OnlySupportShutoff | 只有关机状态才可以进行此操作，请确认云主机状态 |
| LiteEcs.OrderCheck.CustomerNotSupport | 预付费用户不支持自动审批退订，请确认用户信息 |
| LiteEcs.Order.ProcFailed | 订单处理失败 |
