接口功能介绍
删除物理机
接口约束
- 计费类型为按量付费的物理机通过此接口可以直接销毁（实例直接销毁，没有保留期）
- 计费类型为包周期的物理机通过此接口可以退订（实例退订保留期结束后自动销毁）
- 当前仅支持预付费用户退订计费类型为包周期的物理机
- 物理机必须处于已停止状态（STOPPED状态）才可操作，其他状态不可操作
URI
POST /v4/ebm/delete
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 您可以调用资源池列表查询获取最新的天翼云资源池列表 |
73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| azName | 是 | String | 可用区名称，您可以查看地域和可用区来了解可用区 您可以调用资源池可用区查询 注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default） |
default | |
| instanceUUID | 是 | String | 实例UUID | ss-eztbrc1j541lb2pim0lxr3uctdfo | |
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | ea1b9004-f450-11ec-8d4f-00155de3fd73 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.Delete.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，参考表returnObj | {} | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | 100054c0416811e9a6690242ac110002 | |
| masterOrderID | String | 订单ID | 86f7f49e241a11edb4f83003c86a1328 | |
| masterOrderNO | String | 订单号 | 20220825100639650114 |
请求示例
请求头header
无
请求体body
{
"regionID": "100054c0416811e9a6690242ac110002",
"azName": "az2",
"instanceUUID": "ss-eztbrc1j541lb2pim0lxr3uctdfo",
"clientToken": "ea1b9004-f450-11ec-8d4f-00155de3fd73"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"regionID": "100054c0416811e9a6690242ac110002",
"masterOrderID": "86f7f49e241a11edb4f83003c86a1328",
"masterOrderNO": "20220825100639650114"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.Delete.NotValid | 请求参数非法 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| Ebm.Delete.NotsupportedUnexpired | 不支持的退订请求 |
| 其他 | 参见公共错误码说明 |
