# CreateEips
## 1. 接口描述
本接口(CreateEips)用于创建弹性公网IP。
{% hint style="info" %}
**注意事项**
* 可以通过调用[`DescribeEipRegions`](https://docs.console.zenlayer.com/api-reference/cn/compute/zec/elastic-ip/describeeipregions) 来查询支持弹性IP的区域。
* 可以通过调用 [`DescribeEipInternetChargeTypes`](https://docs.console.zenlayer.com/api-reference/cn/compute/zec/elastic-ip/describeeipinternetchargetypes) 来查询公网IP支持的网络计费方式。
* 如果需要创建`Remote EIP`,可以先查询[`DescribeEipRemoteRegions`](https://docs.console.zenlayer.com/api-reference/cn/compute/zec/elastic-ip/describeeipremoteregions)来查询支持远端节点。
* 如果需要通过`CIDR`进行分配，可以先查询[`DescribeCidrs`](https://docs.console.zenlayer.com/api-reference/cn/compute/zec/cidr-block/describecidrs)来查询账号下的`CIDR`。
* 如果同时绑定实例，需要保证所选实例的`主网卡`上的`主内网IP`还能再分配EIP。
{% endhint %}
## 2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
| 参数名称 | 必选 | 类型 | 描述 |
| ------------------ | -- | ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| regionId | 是 | String | 创建EIP所在的节点ID。 |
| name | 是 | String | EIP的名称。
范围2到63个字符。
仅支持输入字母、数字、-/\_和英文句点(.)。
且必须以数字或字母开头和结尾。
|
| internetChargeType | 是 | [InternetChargeType](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#internetchargetype) | 公网弹性IP的网络计费方式。 |
| amount | 否 | Integer | 需要创建EIP的数量。
可选值范围：\[1, +)
默认值：1
|
| eipV4Type \[已废弃] | 否 | [EipNetworkType](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#eipnetworktype) | 公网弹性IP的线路类型。
已废弃，请使用networkLineType。
|
| networkLineType | 否 | [NetworkLineType](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#networklinetype) | 公网弹性IP的线路类型。 |
| primaryIsp | 否 | [EipIsp](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#eipisp) | 主公网IP的运营商。
该字段仅作用于三线IP(ThreeLine)。
|
| bandwidth | 否 | Integer | 公网弹性IP的带宽限速。
单位：Mbps。
可选值范围：\[1, +)
|
| cidrId | 否 | String | 指定CIDR ID，使用CIDR内分配弹性IP。
该字段和eipV4Type不能同时指定。
|
| publicIp | 否 | String | 从CIDR里指定公网起始IP地址开始创建弹性IP。
该字段仅在指定cidrId时生效。
|
| resourceGroupId | 否 | String | 弹性公网IP所放的资源组ID，如不指定则放入默认资源组。 |
| flowPackage | 否 | Float | 公网IPv6的流量包大小。
单位为TB。
值要求为0或0.1的倍数。
当子网的堆栈类型包括V6且为公网时，且网络计费方式是流量计费(ByTrafficPackage)需要指定。
可选值范围：\[0.0, +)
|
| clusterId | 否 | String | 公网IPv6所指定的共享带宽包ID。
当子网的堆栈类型包括V6且为公网时，且网络计费方式是共享带宽包计费(BandwidthCluster)需要指定。
|
| peerRegionId | 否 | String | 远端的节点ID。 |
| marketingOptions | 否 | [MarketingInfo](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#marketinginfo) | 市场营销的相关选项。 |
| tags | 否 | [TagAssociation](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#tagassociation) | 弹性公网IP绑定的标签。
注意：实例关联标签键不能重复。
|
| instanceIds | 否 | Array of String | 要绑定的实例ID集合。
数量需要与amount字段一致。
|
| bindType | 否 | [BindType](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#bindtype) | 绑定类型。
当指定定instanceIds时生效。
默认为普通NAT模式。
|
## 3. 响应结果
| 参数名称 | 类型 | 描述 |
| ----------- | --------------- | -------------------------------------------------------- |
| requestId | String | 唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 requestId。
|
| eipIds | Array of String | 创建的弹性公网IP ID列表。 |
| orderNumber | String | 本次创建的订单编号。 |
## 4. 代码示例
{% tabs %}
{% tab title="示例" %}
**1. 创建一个BGP线路的公网弹性IP, 使用流量包计费。流量包大小为10TB。带宽限速为50Mbps。**
```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateEips
Request：
{
"regionId": "asia-east-1",
"amount": 1,
"name": "Test-EIP",
"internetChargeType": "ByTrafficPackage",
"networkLineType": "PremiumBGP",
"bandwidth": 50,
"flowPackage": 10
}
```
**2. 从CIDR里分配2个公网弹性IP, 使用固定带宽计费。带宽限速为50Mbps。**
```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateEips
Request：
{
"regionId": "asia-east-1",
"amount": 2,
"name": "Test-EIP",
"internetChargeType": "ByBandwidth",
"cidrId": "",
"bandwidth": 50
}
Response：
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"eipIds": ["", ""],
"orderNumber": ""
}
}
```
**3. 创建一个`Remote IP`,远端节点为`asia-southwest-1`, 使用共享带宽包计费。**
```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateEips
Request：
{
"regionId": "asia-east-1",
"amount": 1,
"name": "Test-RemoteIP",
"internetChargeType": "BandwidthCluster",
"networkLineType": "PremiumBGP",
"bandwidth": 50,
"clusterId": "",
"resourceGroupId": "xxxx",
"peerRegionId": "asia-southwest-1"
}
Response：
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"eipIds": [""],
"orderNumber": ""
}
}
```
{% endtab %}
{% endtabs %}
## 5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/toolkit)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。
## 6. 错误码
下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/commonerrorcode)
| HTTP状态码 | 错误码 | 说明 |
| ------- | --------------------------------------------------------------- | ---------------------- |
| 404 | INVALID\_CIDR\_NOT\_FOUND | CIDR地址段不存在。 |
| 400 | INVALID\_PARAMETER\_BANDWIDTH\_ERROR | 带宽限速值超过最小限制。 |
| 400 | INVALID\_PARAMETER\_BANDWIDTH\_EXCEED | 带宽限速值超过最大限制。 |
| 404 | INVALID\_REGION\_NOT\_FOUND | 指定的可用区不存在。 |
| 400 | OPERATION\_DENIED\_CIDR\_IP\_INSUFFICIENT | CIDR剩余IP不足。 |
| 400 | OPERATION\_DENIED\_CIDR\_STATUS | 指定的CIDR状态不支持该操作。 |
| 400 | OPERATION\_DENIED\_EIP\_UNSUPPORT\_CUSTOMIZE | 手动指定的IP地址不合法。 |
| 400 | OPERATION\_DENIED\_EIP\_UNSUPPORT\_NETWORK\_TYPE | EIP网络计费方式不支持。 |
| 400 | OPERATION\_DENIED\_EIP\_UNSUPPORT\_REMOTE\_IPT | 该客户暂时不支持配置Remote IPT。 |
| 400 | OPERATION\_DENIED\_INTERNET\_CHARGE\_TYPE\_NOT\_SUPPORT | IP网络计费方式不支持。 |
| 400 | OPERATION\_DENIED\_EIP\_NOT\_SUPPORT\_PASS\_THROUGH\_BIND\_TYPE | EIP模式不支持高速模式。 |
| 400 | INVALID\_REGION\_MISMATCH | 区域不匹配。 |
| 400 | OPERATION\_DENIED\_EIP\_INSTANCE\_NOT\_ADAPTER | 指定的实例数量与需要创建的EIP数量不一致。 |
| 404 | INVALID\_INSTANCE\_NOT\_FOUND | 服务器实例不存在。 |
| 400 | INVALID\_NIC\_STATUS | 当前网卡状态无法进行操作。 |
| 400 | OPERATION\_DENIED\_LAN\_EIP\_TYPE\_CONFLICTS | 内网IP上的公网Ipv4类型冲突。 |
| 400 | OPERATION\_DENIED\_EIP\_ASSIGNED\_LIMIT\_EXCEEDED | EIP绑定超过数量限制。 |