> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/bmc/elastic-ip/associateeipaddress.md).

# AssociateEipAddress

## 1. 接口描述

本接口(AssociateEipAddress)用于将EIP绑定到同区域的机器实例上。

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

* 只有状态为 **AVAILABLE** 的EIP才能操作。
* EIP与机器实例的可用区需一致。
* 机器实例的状态需要是**RUNNING。**
* 开启了网关模式（gateway mode，Esxi 操作系统的实例会自动开启）的机器实例，只能绑定掩码 <= 29 的 IPv4 EIP。
* 绑定 IPv6 EIP 时，机器实例必须已有母 IPv6 地址；若项目开启了"IPv6 EIP 与 VLAN 互斥"配置，已加入 VLAN 的机器实例不能再绑定 IPv6 EIP。
* 一个机器实例能绑定的同类型（IPv4/IPv6）EIP 数量有限额，如需提高限额，请联系support。
* 本接口属于异步接口，即系统会先返回一个请求ID，但EIP与机器实例并未绑定完成，系统后台的绑定任务仍在进行。您可以调用`DescribeEipAddresses`查询EIP的状态：
  * 当EIP处于 **ASSOCIATING** 状态时，表示EIP正在绑定中，在该状态下，您只能执行查询操作，不能执行其他操作。
  * 当EIP处于 **ASSOCIATED** 状态时，表示EIP绑定完成。
    {% endhint %}

## 2. 请求参数

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

| 参数名称       | 必选 | 类型     | 描述                                                            |
| ---------- | -- | ------ | ------------------------------------------------------------- |
| eipId      | 是  | String | <p>一个EIP ID。</p><p>可通过DescribeEipAddresses接口返回值中的eipId获取。</p> |
| instanceId | 是  | String | <p>机器实例ID。</p><p>可通过DescribeInstances接口返回值中的instanceId获取。</p> |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                       |
| --------- | ------ | -------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. EIP绑定机器实例**

```json
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: AssociateEipAddress
Request：
{
    "eipId": "eipId1",
    "instanceId": "instanceId1"
}
Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": { 
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

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

## 6. 错误码

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

| HTTP状态码 | 错误码                                               | 说明                                      |
| ------- | ------------------------------------------------- | --------------------------------------- |
| 404     | INVALID\_INSTANCE\_NOT\_FOUND                     | 实例不存在。                                  |
| 403     | OPERATION\_DENIED\_INSTANCE\_RECYCLED             | 实例在回收站。                                 |
| 403     | OPERATION\_DENIED\_INSTANCE\_NOT\_RUNNING         | 实例状态不是Running。                          |
| 404     | INVALID\_EIP\_NOT\_FOUND                          | 指定的EIP不存在。                              |
| 403     | OPERATION\_DENIED\_EIP\_ZONE\_NOT\_SAME           | 指定的EIP与实例区域不一致。                         |
| 403     | OPERATION\_DENIED\_EIP\_STATUS\_NOT\_AVAILABLE    | 指定的EIP状态不可用。                            |
| 403     | OPERATION\_DENIED\_EIP\_GATEWAY\_INSTANCE\_ASSIGN | 网关模式实例只能绑定掩码不大于29的IPv4 EIP。             |
| 403     | OPERATION\_DENIED\_IPV6\_EIP\_VLAN\_MUTEX         | IPv6 EIP与VLAN互斥，已加入VLAN的实例不能绑定IPv6 EIP。 |
| 403     | OPERATION\_DENIED\_INSTANCE\_IPV6\_REQUIRED       | 绑定IPv6 EIP要求实例已有母IPv6地址。                |