> 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/describeinstanceavailableeipresources.md).

# DescribeInstanceAvailableEipResources

## 1. 接口描述

本接口(DescribeInstanceAvailableEipResources)用于查询实例可绑定的EIP列表。

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

* 返回结果只包含按业务规则确实可以绑定到该实例的 EIP，以下情况会被过滤掉：实例已绑定的同类型 EIP 数量达到配额上限；实例开启了网关模式（gateway mode）且 EIP 为 IPv4 掩码大于 29；查询 IPv6 类型时，该实例没有母 IPv6 地址。
* `ipType` 不填时默认查询 IPv4 类型的可用 EIP。
  {% endhint %}

## 2. 请求参数

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

| 参数名称       | 必选 | 类型                                                            | 描述                                                           |
| ---------- | -- | ------------------------------------------------------------- | ------------------------------------------------------------ |
| instanceId | 是  | String                                                        | <p>机器实例ID 。</p><p>可通过DescribeInstances接口返回的instanceId获取。</p> |
| ipType     | 否  | [EipIpType](/api-reference/cn/bmc/datastructure.md#eipiptype) | <p>EIP 类型，取值：IPv4、IPv6。不填默认查询 IPv4。</p><p>默认值：IPv4</p>       |

## 3. 响应结果

| 参数名称                 | 类型                                                                                           | 描述                                                       |
| -------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| requestId            | String                                                                                       | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| instanceEipResources | Array of [InstanceAvailableEip](/api-reference/cn/bmc/datastructure.md#instanceavailableeip) | 实例可用EIP列表。                                               |

## 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: DescribeInstanceAvailableEipResources
Request：
{
    "instanceId": "instanceId1",
    "ipType": "IPv4"
}
Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "instanceEipResources": [
        {
             "eipId": "eipId1",
             "ipAddress": "xx.x.x.x",
             "netmask": 32
        }
    ]
  }
}
```

{% 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 | 实例不存在。 |