CreateEips

1. 接口描述

本接口(CreateEips)用于创建弹性公网IP。

注意事项

• 可以通过调用DescribeEipRegions 来查询支持弹性IP的区域。

• 可以通过调用 DescribeEipInternetChargeTypes 来查询公网IP支持的网络计费方式。

• 如果需要创建Remote EIP,可以先查询DescribeEipRemoteRegions来查询支持远端节点。

• 如果需要通过CIDR进行分配，可以先查询DescribeCidrs来查询账号下的CIDR。

• 如果同时绑定实例，需要保证所选实例的主网卡上的主内网IP还能再分配EIP。

• 指定prefixLength小于32时创建EIP Block资源，同时绑定实例时bindType只能为Passthrough。

• 指定publicIp时，prefixLength为32表示指定纯IPv4起始地址，小于32时表示指定带掩码的起始网段（掩码须与prefixLength一致，如88.0.5.64/26）。指定cidrId时，该起始地址/网段必须是所选CIDR当前可分配的候选之一；不指定cidrId时（仅支持prefixLength为32），从公网IP池按此地址开始顺序分配。

• 保底流量包大小仅对计费周期为月有效。

2. 请求参数

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

参数名称	必选	类型	描述
regionId	是	String	创建EIP所在的节点ID。
name	是	String	EIP的名称。 范围2到63个字符。 仅支持输入字母、数字、-/_和英文句点(.)。 且必须以数字或字母开头和结尾。
internetChargeType	是	InternetChargeType	公网弹性IP的网络计费方式。
amount	否	Integer	需要创建EIP的数量。 可选值范围：[1, +) 默认值：1
prefixLength	否	Integer	掩码长度，取值范围24–32，默认32。 指定小于32时，创建EIP Block资源，必须同时指定cidrId，且不能小于所选CIDR自身的掩码长度。 可选值范围：[24, 32] 默认值：32
eipV4Type [已废弃]	否	EipNetworkType	公网弹性IP的线路类型。 已废弃，请使用networkLineType。
networkLineType	否	NetworkLineType	公网弹性IP的线路类型。
primaryIsp [已废弃]	否	EipIsp	主公网IP的运营商。
bandwidth	否	Integer	公网弹性IP的带宽限速。 单位：Mbps。 可选值范围：[1, +)
cidrId	否	String	指定CIDR ID，使用CIDR内分配弹性IP。 该字段和eipV4Type不能同时指定。
publicIp	否	String	指定公网起始地址开始创建弹性IP。 不指定cidrId时，从公网IP池按此地址开始顺序分配（仅支持prefixLength为32）；指定cidrId时，从该CIDR内按此地址开始分配。 prefixLength为32时填纯IPv4地址；prefixLength小于32时必须同时指定cidrId，填带掩码的起始网段（掩码须与prefixLength一致，如88.0.5.64/26）。
resourceGroupId	否	String	弹性公网IP所放的资源组ID，如不指定则放入默认资源组。
flowPackage	否	Float	弹性公网IP的流量包大小。 单位为TB。 值要求为0或0.1的倍数。 当网络计费方式为流量计费(ByTrafficPackage)时需要指定。 可选值范围：[0.0, +)
clusterId	否	String	共享带宽包ID。 当网络计费方式为共享带宽包计费(BandwidthCluster)时需要指定。
peerRegionId	否	String	远端的节点ID。
marketingOptions	否	MarketingInfo	市场营销的相关选项。
tags	否	TagAssociation	弹性公网IP绑定的标签。 注意：实例关联标签键不能重复。
instanceIds	否	Array of String	要绑定的实例ID集合。 数量需要与amount字段一致。
bindType	否	BindType	绑定类型。 当指定instanceIds时生效。 默认为普通NAT模式。
rateLimitMode	否	RateLimitMode	限速模式。 STRICT严格模式必须同时指定bandwidth。 默认值：LOOSE

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
eipIds	Array of String	创建的弹性公网IP ID列表。
orderNumber	String	本次创建的订单编号。

4. 代码示例

示例

1. 创建一个BGP线路的公网弹性IP, 使用流量包计费。流量包大小为10TB。带宽限速为50Mbps。

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

Request：
{
  "regionId": "asia-east-1",
  "amount": 1,
  "name": "Test-EIP",
  "internetChargeType": "ByTrafficPackage",
  "networkLineType": "PremiumBGP",
  "bandwidth": 50,
  "flowPackage": 10,
  "rateLimitMode": "LOOSE"
}

2. 从CIDR里分配2个公网弹性IP, 使用固定带宽计费。带宽限速为50Mbps。

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

Request：
{
  "regionId": "asia-east-1",
  "amount": 2,
  "name": "Test-EIP",
  "internetChargeType": "ByBandwidth",
  "cidrId": "<cidrId>",
  "bandwidth": 50
}
  
Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "eipIds": ["<eipId>", "<eipId2>"],
    "orderNumber": "<orderNumber>"
  }
}

3. 创建一个Remote IP,远端节点为asia-southwest-1, 使用共享带宽包计费。

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

Request：
{
  "regionId": "asia-east-1",
  "amount": 1,
  "name": "Test-RemoteIP",
  "internetChargeType": "BandwidthCluster",
  "networkLineType": "PremiumBGP",
  "bandwidth": 50,
  "clusterId": "<clusterId>",
  "resourceGroupId": "xxxx",
  "peerRegionId": "asia-southwest-1"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "eipIds": ["<eipId>"],
    "orderNumber": "<orderNumber>"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_CIDR_NOT_FOUND	CIDR地址段不存在。
404	INVALID_CIDR_IP_NOT_FOUND	指定的IP地址在CIDR中不存在。
400	INVALID_PREFIX_LENGTH_OUT_OF_RANGE	EIP掩码长度不合法。
400	INVALID_PREFIX_LENGTH_MUST_EXCEED_CIDR_NETMASK	EIP掩码长度必须大于所选 CIDR 的掩码长度。
400	INVALID_STARTING_CIDR_PREFIX_MISMATCH	指定的起始网段掩码长度和 prefixLength 不一致。
400	INVALID_PARAMETER_BANDWIDTH_ERROR	带宽限速值超过最小限制。
400	INVALID_RATE_LIMIT_MODE_REQUIRES_BANDWIDTH	限速模式为STRICT时必须指定带宽。
400	OPERATION_DENIED_CIDR_CREATE_SOURCE	该CIDR来源不支持此操作。
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_UNSUPPORTED_CUSTOMIZE	手动指定的IP地址不合法。
400	INVALID_IP_NETWORK_ADDRESS	IP为网络地址不可用。
400	INVALID_IP_BROADCAST_ADDRESS	IP为广播地址不可用。
400	OPERATION_DENIED_EIP_UNSUPPORTED_NETWORK_TYPE	EIP网络计费方式不支持。
400	OPERATION_DENIED_EIP_UNSUPPORTED_REMOTE_IPT	该客户暂时不支持配置Remote IPT。
400	OPERATION_DENIED_INTERNET_CHARGE_TYPE_NOT_SUPPORT	IP网络计费方式不支持。
400	INVALID_REGION_MISMATCH	EIP与目标资源不在同一区域。
400	OPERATION_DENIED_EIP_INSTANCE_NOT_ADAPTER	指定的实例数量与需要创建的EIP数量不一致。
404	INVALID_INSTANCE_NOT_FOUND	服务器实例不存在。
400	INVALID_NIC_STATUS	当前网卡状态无法进行操作。
400	OPERATION_DENIED_EIP_ASSIGNED_LIMIT_EXCEEDED	EIP绑定超过数量限制。
400	OPERATION_DENIED_FLOW_PACKAGE_NOT_SUPPORTED_HOUR_PERIOD	当前产品周期为小时计费，不支持设置保底流量包大小。
400	INVALID_PARAMETER_FLOW_PACKAGE_NOT_SUPPORTED_FOR_PATH_BASED	PathBasedBandwidthIP 不支持自定义流量包大小，需传 0 或不传。
400	OPERATION_DENIED_FIXED_BANDWIDTH_NOT_SUPPORTED_FOR_PATH_BASED	PathBasedBandwidthIP 不支持固定带宽计费。
400	INVALID_EIP_BINDING_MODE_UNSUPPORTED	EIP Block不支持NAT绑定模式。