# Get Elastic IP Price - GetEIPPrice

## Overview

Get Elastic IP Price






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetEIPPrice`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.zosoc.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the [GetProjectList interface](api/summary/get_project_list). |No|
| **OperatorName** | string | The routes for Elastic IP are as follows: International: International BGP: Bgp. The allowed route parameters for each region are as follows: cn-sh1: Bgp cn-sh2: Bgp cn-gd: Bgp cn-bj1: Bgp cn-bj2: Bgp hk: International us-ca: International th-bkk: International kr-seoul: International us-ws: International ge-fra: International sg: International tw-kh: International. All other overseas routes are International, Quanzhou is a single mobile line cn-qz: ChinaMobile. |**Yes**|
| **Bandwidth** | int | The bandwidth of the Elastic IP for the public network, measured in Mbps, ranges from [0-800]. |**Yes**|
| **ChargeType** | string | Payment method, enumerated values are: Year, pay yearly; Month, pay monthly; Dynamic, pay hourly; Default is to get prices for all three methods. |No|
| **PayMode** | string | Elastic IP Billing Method r. Enumeration values are: Traffic, traffic billing; Bandwidth, bandwidth billing; "ShareBandwidth", shared bandwidth mode. The default is Bandwidth. |No|
| **Quantity** | int | Purchase duration. Default: 1. This parameter is not required when purchasing hourly (Dynamic). When paying monthly, pass this parameter as 0, which represents purchase until the end of the month. |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **PriceSet** | array[[*EIPPriceDetailSet*](#eippricedetailset)] | Elastic IP Price Details See EIPPriceDetailSet |No|

#### Data Model


#### EIPPriceDetailSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ChargeType** | string | Elastic IP Payment Method |No|
| **Price** | float | Actual price for purchasing Elastic IP, unit "yuan"  |No|
| **OriginalPrice** | float | Original price of Elastic IP, unit "Yuan"  |No|
| **PurchaseValue** | int | Resource Validity, represented by Unix Timestamp |No|

## Example

### Request Example
    
```
https://api.zosoc.com/?Action=GetEIPPrice
&Region=cn-bj2
&OperatorName=Bgp
&Bandwidth=4
&ChargeType=Month
&PayMode=Traffic
&Quantity=2
```

### Response Example
    
```json
{
  "Action": "GetEIPPriceResponse",
  "PriceSet": [
    {
      "ChargeType": "Dynamic",
      "Price": 0.1,
      "PurchaseValue": 1529900854
    },
    {
      "ChargeType": "Month",
      "Price": 50,
      "PurchaseValue": 1532489254
    },
    {
      "ChargeType": "Year",
      "Price": 500,
      "PurchaseValue": 1561433254
    }
  ],
  "Request_uuid": "b2f6d562-4a22-428b-b88c-XXXXXX",
  "RetCode": 0
}
```