DescribeEipPrice

1. API Description

This API (DescribeEipPrice) is used to query the price of elastic IPs.

Notes

• The size of the guaranteed traffic package is only valid for billing periods of one month.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
regionId	Yes	String	Region ID
internetChargeType	Yes	InternetChargeType	Network billing methods.
amount	No	Integer	Quantity. Value range: [1, +) Default value: 1
eipV4Type [Deprecated]	No	EipNetworkType	Network types of public IPv4. Deprecated. Please use networkLineType instead.
networkLineType	No	NetworkLineType	Network types of public IPv4.
bandwidth	No	Integer	Bandwidth limit for the elastic public IP. Unit: Mbps. Value range: [1, +)
flowPackage	No	Float	Data transfer package size for public IPv6. Unit: TB. Value must be 0 or a multiple of 0.1. Required when the subnet stack type includes IPv6 with public internet access and the billing type is ByTrafficPackage. Value range: [0.0, +)
cidrId	No	String	CIDR ID. Specifies the CIDR block from which an elastic IP is allocated. This field and eipV4Type cannot be specified at the same time.
clusterId	No	String	Bandwidth cluster ID. If the value of internetChargeType is Bandwidth , clusterld is required.
peerRegionId	No	String	Remote region ID.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
eipPrice	PriceItem	Reservation price of the elastic public IP. If the elastic IP is created from a CIDR block, the reservation price is null.
bandwidthPrice	PriceItem	Price of bandwidth.
bandwidthPrices	Array of BandwidthPriceResponseItem	Bandwidth price details for each traffic direction.
remoteBandwidthPrice	PriceItem	Price of remote ipt.

4. Code Example

Example

Query the price of elastic IPs.

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


Request:
{
  "regionId": "xxx",
  "amount": 1,
  "internetChargeType": "ByTrafficPackage",
  "eipV4Type": "BGPLine",
  "flowPackage": 2
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "eipPrice": {
        "discount": 95.0,
        "discountPrice": 1444.0,
        "originalPrice": 1520.0,
        "unitPrice": null,
        "discountUnitPrice": null,
        "chargeUnit": null,
        "stepPrices": null
    },
    "bandwidthPrice": {
        "discount": 95.0,
        "discountPrice": 1444.0,
        "originalPrice": 1520.0,
        "unitPrice": null,
        "discountUnitPrice": null,
        "chargeUnit": null,
        "stepPrices": null
    },
    "remoteBandwidthPrice":null
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs，to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description
400	OPERATION_DENIED_FLOW_PACKAGE_NOT_SUPPORTED_HOUR_PERIOD	The current product cycle is based on hourly billing and does not support setting a minimum data package size.