CreateEips

CreateEips

1. 接口描述

调用本接口用于创建一个或多个EIP

准备工作

  • 查询支持购买EIP的区域:调用DescribeEipRegions接口。

  • 查询EIP支持的带宽网络类型:调用DescribeEipInternetChargeTypes接口。

  • 查询CIDR的ID:调用DescribeCidrs接口。

注意事项

  • 参数eipV4Type与cidrId 互斥,不支持同时传 且 不能同时为空。

  • 传cidrId参数表示从CIDR地址段中生成公网IP。

  • publicIp参数表示从该地址IP为起始。

2. 请求参数

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

参数名称
必选
类型
描述

regionId

String

节点ID

amount

Integer

数量

name

String

EIP的名称

internetChargeType

String

eipV4Type

String

primaryIsp

String

若eipV4Type字段值为ThreeLine,则该字段必传 CHINA_TELECOM CHINA_UNICOM CHINA_MOBILE

bandwidth

Integer

带宽

flowPackage

BigDecimal

流量包

cidrId

String

CIDR的ID

publicIp

String

公网起始IP

resourceGroupId

String

资源组

clusterId

String

带宽组id。当internetChargeType=BandwidthCluster时必传。

peerRegionId

String

远端节点ID

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

eipIds

Array of String

EIP的ID集合

orderNumber

String

订单编号

4. 代码示例

1. 创建一个或多个EIP

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": "xxx",
  "internetChargeType": "ByTrafficPackage",
  "eipV4Type": "BGPLine",
  "bandwidth": 50,
  "flowPackage": 2,
  "resourceGroupId": "xxxx"
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "eipIds": ["xxx","xxx"],
    "orderNumber": "xxx"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码
错误码
说明

404

INVALID_REGION_NOT_FOUND

节点不存在。

400

INVALID_PARAMETER_TYPE

参数错误。

400

INVALID_PARAMETER_BANDWIDTH_EXCEED

带宽超过限制。

最后更新于