# TerminateEipAddress

## 1. 接口描述

本接口用于退还一个EIP。

{% hint style="info" %}
**注意事项**

* 不再使用的EIP，可通过本接口主动退还。如果是后付费，退还的EIP将停止计费。
* 本接口无法主动退还预付费订阅模式的EIP，**订阅模式**的EIP将会在订阅到期后自动退还。
* 退还后的EIP将进入回收站，进入回收站后如无其他操作EIP将在24小时后自动释放，也可以调用`ReleaseEipAddresses`接口主动进行释放。
* 该接口只能被 EIP 状态处于 **AVAILABLE** 或 **ASSOCIATED** 或 **CREATE\_FAILED** 调用。
* 对于创建失败状态为 **CREATE\_FAILED**的EIP， 会自动退还所有的已支付金额。
* 处于 **ASSOCIATED** 状态的EIP，系统会将EIP与机器解绑。
  {% endhint %}

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

<table><thead><tr><th width="188">参数名称</th><th width="85">必选</th><th width="125">类型</th><th>描述</th></tr></thead><tbody><tr><td>eipId</td><td>是</td><td>String</td><td><p>一个EIP ID。</p><p>可通过<code>DescribeEipAddresses</code>接口返回值中的<code>eipId</code>获取。</p></td></tr></tbody></table>

## 3. 响应结果

<table><thead><tr><th>参数名称</th><th width="158.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td><p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 RequestId。</p></td></tr></tbody></table>

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 退还指定ID EIP**

退还指定EIP。

```json
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: TerminateEipAddress
<Common Request Params>

Request：
{
    "eipId": "eipId"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](https://docs.console.zenlayer.com/api/cn/api-introduction/toolkit)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api/cn/api-introduction/instruction/commonerrorcode)

<table><thead><tr><th width="158.33333333333331">HTTP状态码</th><th>错误码</th><th>说明</th></tr></thead><tbody><tr><td>404</td><td>INVALID_EIP_NOT_FOUND</td><td>指定的EIP不存在。</td></tr><tr><td>403</td><td>OPERATION_DENIED_EIP_SUBSCRIPTION</td><td>订阅模式的EIP不支持该操作。</td></tr><tr><td>403</td><td>OPERATION_DENIED_EIP_RECYCLED</td><td>已经在回收站中的EIP不支持该操作。</td></tr></tbody></table>
