ModifyEipBandwidth

1. API Description

This API is used to modify bandwidth of the elastic IP.

Note

Operation is only supported for the elastic IP in status of BINDED or UNBIND.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
eipId	Yes	String	Elastic IP ID.
bandwidth	Yes	Integer	Target bandwidth. Unit: Mbps. Available value range: [1, +).
commitBandwidth	No	Integer	Bandwidth commitment. This parameter is configured for the backbone network. The value is only required when the IP type is Remote IP, and the network billing method is Bandwidth Cluster. Unit: Mbps. Available 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.

4. Code Example

Example

Change bandwidth of the elastic IP to 10 Mbps.

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

Request：
{
    "eipId": "< EipId >",
    "bandwidth": 10
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

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.
400	INVALID_PARAMETER_BANDWIDTH_EXCEED	Bandwidth size exceeds the upper limit.
500	OPERATION_DENIED_EIP_STATUS_NOT_SUPPORT	Operation is not supported for the elastic IP in current status.
400	INVALID_PARAMETER_BANDWIDTH	Invalid bandwidth size.