InquiryPriceModifyEipBandwidth

1. API Description

This API (InquiryPriceModifyEipBandwidth) is used to inquire the price after adjusting the EIP bandwidth. The currently effective price of each billing item before the change is also returned through previousPrices, so that you can compare which billing items have price changes.

Notes

• Only EIPs in an available state (BINDED or UNBIND) billed by bandwidth (ByBandwidth) support this operation.

• The international route (PathBasedBandwidthIP) does not support this operation.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
eipId	Yes	String	Elastic IP to be operated on. It can be obtained by calling DescribeEips.
bandwidth	Yes	Integer	Bandwidth limit after adjustment. Unit: Mbps. Value range: [1, +)

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	Retention price of the elastic IP. Null for IPs created via CIDR.
bandwidthPrice	PriceItem	Bandwidth price for the elastic IP. Null for the PathBasedBandwidthIP line type; see bandwidthPrices for details.
bandwidthPrices	Array of BandwidthPriceResponseItem	Bandwidth price details for each traffic direction. Multiple items are returned for the PathBasedBandwidthIP line type; a single item (trafficType=ALL) is returned for other line types.
remoteBandwidthPrice	PriceItem	Bandwidth price for Remote IPT. Null when Remote IPT is not enabled for the EIP.
previousPrices	EipPreviousPrices	Currently effective price of each billing item before the change. The fields correspond one by one to those above and are used to compare which billing items have price changes. It is null when there is no order.

4. Code Example

Example

Inquire the price after adjusting the EIP bandwidth to 20 Mbps.

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

Request：
{
  "eipId": "eip-xxx",
  "bandwidth": 20
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "eipPrice": {
      "discount": 100.0,
      "discountPrice": null,
      "originalPrice": null,
      "unitPrice": 0.005,
      "discountUnitPrice": 0.005,
      "chargeUnit": "HOUR",
      "stepPrices": null
    },
    "bandwidthPrice": {
      "discount": 100.0,
      "discountPrice": null,
      "originalPrice": null,
      "unitPrice": 0.02,
      "discountUnitPrice": 0.02,
      "chargeUnit": "HOUR",
      "stepPrices": null
    },
    "bandwidthPrices": [
      {
        "trafficType": "ALL",
        "price": {
          "discount": 100.0,
          "discountPrice": null,
          "originalPrice": null,
          "unitPrice": 0.02,
          "discountUnitPrice": 0.02,
          "chargeUnit": "HOUR",
          "stepPrices": null
        }
      }
    ],
    "remoteBandwidthPrice": null,
    "previousPrices": {
      "eipPrice": {
        "discount": 100.0,
        "discountPrice": null,
        "originalPrice": null,
        "unitPrice": 0.005,
        "discountUnitPrice": 0.005,
        "chargeUnit": "HOUR",
        "stepPrices": null
      },
      "bandwidthPrice": {
        "discount": 100.0,
        "discountPrice": null,
        "originalPrice": null,
        "unitPrice": 0.015,
        "discountUnitPrice": 0.015,
        "chargeUnit": "HOUR",
        "stepPrices": null
      },
      "bandwidthPrices": [
        {
          "trafficType": "ALL",
          "price": {
            "discount": 100.0,
            "discountPrice": null,
            "originalPrice": null,
            "unitPrice": 0.015,
            "discountUnitPrice": 0.015,
            "chargeUnit": "HOUR",
            "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
404	INVALID_EIP_NOT_FOUND	Elastic IP does not exist.
500	OPERATION_DENIED_EIP_STATUS_NOT_SUPPORT	Operations on the EIP with current status are not supported.
400	OPERATION_DENIED_INTERNET_CHARGE_TYPE_NOT_SUPPORT	IP network billing type is not supported.
400	OPERATION_DENIED_EIP_UNSUPPORTED_INTERNET_CHARGE_TYPE	The target network billing method is not supported.
400	INVALID_PARAMETER_BANDWIDTH_EXCEED	Bandwidth size exceeds the upper limit.