# ReplaceEipAddress

## 1. API Description

This API (ReplaceEipAddress) is used to replace the elastic IP addresses.

{% hint style="info" %} <mark style="color:blue;">**Note**</mark>

* <mark style="color:blue;">`ownIp`</mark> <mark style="color:blue;">is required for a 3-in-1 IP pool.</mark>
* <mark style="color:blue;">The API returns the elastic IP IDs that failed to operate. An empty list indicates all operations succeeded.</mark>
  {% endhint %}

## 2. Input Parameters

The following request parameter list only provides API request parameters.

| Parameter Name | Required | Type                                                                                                  | Description                                   |
| -------------- | -------- | ----------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| replaceIps     | Yes      | Array of [ReplaceIp](https://docs.console.zenlayer.com/api-reference/compute/datastructure#replaceip) | Lists of the original and target elastic IPs. |

## 3. Output Parameters

| Parameter Name | Type            | Description                                                                                                           |
| -------------- | --------------- | --------------------------------------------------------------------------------------------------------------------- |
| requestId      | String          | <p>The unique request ID, which is returned for each request.</p><p>RequestId is required for locating a problem.</p> |
| failedEipIds   | Array of String | Elastic IP IDs that failed to replace.                                                                                |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Replace the elastic IP address.**

<pre class="language-json"><code class="lang-json"><strong>POST /api/v2/zec HTTP/1.1
</strong>Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ReplaceEipAddress


Request:
{
  "replaceIps": [
    {
      "eipId": "xxx",
      "targetIp": "88.188.128.203"
    }
  ]
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "failedEipIds":[],
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F"
  }
}
</code></pre>

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/api-reference/api-introduction/toolkit/api-sdk)，to make it easier for you to call APIs. More programming languages will be supported.

## 6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see [Common Error Codes](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode).

| HTTP Status Code | Error Code                                          | Description                                                         |
| ---------------- | --------------------------------------------------- | ------------------------------------------------------------------- |
| 404              | INVALID\_EIP\_NOT\_FOUND                            | Elastic IP does not exist.                                          |
| 400              | OPERATION\_DENIED\_CIDR\_CREATE\_SOURCE             | Operation not allowed on BYOIPs.                                    |
| 400              | OPERATION\_DENIED\_EIP\_INSUFFICIENT                | Insufficient elastic IP stock.                                      |
| 400              | OPERATION\_DENIED\_EIP\_IN\_RISK\_CONTROL           | This operation is not supported for elastic IPs under risk control. |
| 400              | OPERATION\_DENIED\_EIP\_IP\_CHANGE\_LIMIT\_EXCEEDED | Replacement limit exceeded.                                         |
| 500              | OPERATION\_DENIED\_EIP\_STATUS\_NOT\_SUPPORT        | Operation is not supported for the elastic IP in current status.    |
| 400              | OPERATION\_DENIED\_EIP\_UNSUPPORT\_CUSTOMIZE        | Manually specified IP address is invalid.                           |
| 400              | OPERATION\_EIP\_PUBLIC\_IP\_CONFLICT                | Public IP address conflict exists.                                  |