DescribeEipPrice

1. 接口描述

本接口(DescribeEipPrice)用于创建公网弹性IP询价。

注意事项

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

2. 请求参数

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

参数名称	必选	类型	描述
regionId	是	String	创建EIP所在的节点ID。
internetChargeType	是	InternetChargeType	公网弹性IP的网络计费方式。
amount	否	Integer	需要创建EIP的数量。 可选值范围：[1, +) 默认值：1
eipV4Type [已废弃]	否	EipNetworkType	公网弹性IP的线路类型。 已废弃，请使用networkLineType。
networkLineType	否	NetworkLineType	公网弹性IP的线路类型。
bandwidth	否	Integer	公网弹性IP的带宽限速。 单位：Mbps。 可选值范围：[1, +)
flowPackage	否	Float	弹性公网IP的流量包大小。 单位为TB。 值要求为0或0.1的倍数。 当网络计费方式为流量计费(ByTrafficPackage)时需要指定。 可选值范围：[0.0, +)
cidrId	否	String	指定CIDR ID，使用CIDR内分配弹性IP。 该字段和eipV4Type不能同时指定。
clusterId	否	String	共享带宽包ID。 当指定peerRegionId且网络计费方式为共享带宽包计费(BandwidthCluster)时需要指定。
peerRegionId	否	String	远端的节点ID。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
eipPrice	PriceItem	公网弹性IP的保留价格。 如果是通过cidr创建，则保留价格为null。
bandwidthPrice	PriceItem	公网弹性IP的带宽价格。
bandwidthPrices	Array of BandwidthPriceResponseItem	各流量方向的带宽价格明细。 PathBasedBandwidthIP 线路返回多项（bandwidthPrice 为 null）；其他线路返回单项（trafficType=ALL）。
remoteBandwidthPrice	PriceItem	Remote IPT的带宽价格。

4. 代码示例

示例

1. 查询一个BGP公网IP的价格，网络计费采用流量包计费。流量包大小为10TB。

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

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


Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "eipPrice": {
      "discount": 95.0,
      "discountPrice": 100.0,
      "originalPrice": 100.0,
      "unitPrice": null,
      "discountUnitPrice": null,
      "chargeUnit": null,
      "stepPrices": null
    },
    "bandwidthPrice": {
      "discount": 95.0,
      "discountPrice": 100.0,
      "originalPrice": 100.0,
      "unitPrice": null,
      "discountUnitPrice": null,
      "chargeUnit": null,
      "stepPrices": null
    },
    "bandwidthPrices": [
      {
        "trafficType": "ALL",
        "price": {
          "discount": 95.0,
          "discountPrice": 100.0,
          "originalPrice": 100.0,
          "unitPrice": null,
          "discountUnitPrice": null,
          "chargeUnit": null,
          "stepPrices": null
        }
      }
    ],
    "remoteBandwidthPrice": null
  }
}

2. 查询一个 PathBasedBandwidthIP 的价格，网络计费采用按带宽计费，带宽 50Mbps。境内和境外带宽分别返回价格，bandwidthPrice 为 null。

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

Request：
{
  "regionId": "asia-east-1",
  "amount": 1,
  "internetChargeType": "ByBandwidth",
  "networkLineType": "PathBasedBandwidthIP",
  "bandwidth": 50
}


Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "eipPrice": {
      "discount": 95.0,
      "discountPrice": 100.0,
      "originalPrice": 100.0,
      "unitPrice": null,
      "discountUnitPrice": null,
      "chargeUnit": null,
      "stepPrices": null
    },
    "bandwidthPrice": null,
    "bandwidthPrices": [
      {
        "trafficType": "LOCAL",
        "price": {
          "discount": 100.0,
          "discountPrice": 80.0,
          "originalPrice": 80.0,
          "unitPrice": null,
          "discountUnitPrice": null,
          "chargeUnit": null,
          "stepPrices": null
        }
      },
      {
        "trafficType": "INTERNATIONAL",
        "price": {
          "discount": 100.0,
          "discountPrice": 120.0,
          "originalPrice": 120.0,
          "unitPrice": null,
          "discountUnitPrice": null,
          "chargeUnit": null,
          "stepPrices": null
        }
      }
    ],
    "remoteBandwidthPrice": null
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
400	INVALID_PREFIX_LENGTH_OUT_OF_RANGE	EIP掩码长度不合法。
400	OPERATION_DENIED_FLOW_PACKAGE_NOT_SUPPORTED_HOUR_PERIOD	当前产品周期为小时计费，不支持设置保底流量包大小。