Modifies the name, description, and maximum bandwidth of an elastic IP address (EIP).
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AllocationId | string | Yes | The ID of the pay-as-you-go EIP. | eip-2zeerraiwb7uj6i0d**** |
| Bandwidth | string | No | The new maximum bandwidth of the EIP. Valid values:
| 100 |
| RegionId | string | No | The region ID of the EIP. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| Name | string | No | The new name of the EIP. The name must be 1 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). | Test123 |
| Description | string | No | The new description of the EIP. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with | abc |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | OrderError.EIP | The Account failed to create order. | Failed to place the order. |
| 400 | InsufficientBalance.Eip | Your account does not have enough balance. | Your account balance is insufficient. Top up your account and try again. |
| 400 | InvalidParameter | Specified value of "Bandwidth" is not supported. | The specified bandwidth value is invalid. |
| 400 | Forbidden.ChargeTypeIsPrepaid | It?s forbidden to change prepaid EIP?s bandwidth by API. It can be changed on Aliyun web console. | - |
| 400 | IncorrectEipStatus | Current elastic IP status does not support this operation. | You cannot perform the operation when the specified EIP is in the current state. |
| 400 | InvalidParameter | The parameter is invalid. | The parameter value is invalid. |
| 400 | InvalidBandwidth.OutOfMaxTrafficBindedOnNatgw | The bandwidth is out of max traffic binded on natgw. | - |
| 400 | QuotaExceeded.LargeSpecEip | Elastic IP address with large spec quota exceeded. | - |
| 400 | InvalidEipAddressName.Malformed | The specified Name is not valid. | - |
| 400 | ResourceQueryError | The specified resource is queried error. | An error occurred while querying the specified resource. |
| 400 | InvalidDescription.Malformed | Invalid description. | - |
| 400 | SYSTEM.UNKNOWN.ERROR | The Account failed to create order. | - |
| 400 | Abs.InvalidBandwidth.Malformed | Specified value of Bandwidth is not supported. | - |
| 400 | InvalidEIPStatus.BizDisabled | The EIP has been locked. | The error message returned because the EIP is locked. |
| 400 | OperationFailed.SaleValidate | Validate sale condition with subArticle failed. | Failed to validate the sales condition with a subproject. |
| 400 | OperationFailed.SyncOrderToSub | SyncOrderToSub error. | The operation failed. |
| 400 | COMMODITY.INVALID_COMPONENT | The instance component is invalid. | - |
| 400 | OperationFailed.CompleteUserInfo | Complete user info failed. | - |
| 400 | OperationFailed.ConcurrentRequest | Operation failed because concurrent request. | - |
| 400 | IncorrectStatus.ResourceStatus | Resource status is abnormal for renew. | - |
| 400 | Forbidden.FinancialLocked | The ip business status is invalid. | The error message returned because the instance has overdue payments. |
| 404 | InvalidAllocationId.NotFound | Specified allocation id is not found. | The error message returned because the specified EIP does not exist. Check whether the value of the parameter is valid. |
| 404 | Forbidden.InCommonBandwidthPackage | Specified allocation ID in common bandwidth package. | - |
| 404 | Forbidden.RegionNotFound | Specified region is not found during access authentication. | The specified region does not exist. Check whether the specified region ID is valid. |
| 500 | InternalError | The request processing has failed due to some unknown error. | An unknown error occurred. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error occurred. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-11-09 | The Error code has changed | View Change Details |
| 2023-07-24 | API Description Update. The Error code has changed | View Change Details |