All Products
Search
Document Center

Elastic IP Address:ModifyEipAddressAttribute

Last Updated:Feb 27, 2024

Modifies the name, description, and maximum bandwidth of an elastic IP address (EIP).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:ModifyEipAddressAttributeWrite
  • Address
    acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AllocationIdstringYes

The ID of the pay-as-you-go EIP.

eip-2zeerraiwb7uj6i0d****
BandwidthstringNo

The new maximum bandwidth of the EIP. Valid values:

  • 1 to 200 if the metering method is pay-by-data-transfer. Unit: Mbit/s.
  • 1 to 500 if the metering method is pay-by-bandwidth. Unit: Mbit/s.
100
RegionIdstringNo

The region ID of the EIP.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
NamestringNo

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
DescriptionstringNo

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 http:// or https://.

abc

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Sample success responses

JSONformat

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status codeError codeError messageDescription
400OrderError.EIPThe Account failed to create order.Failed to place the order.
400InsufficientBalance.EipYour account does not have enough balance.Your account balance is insufficient. Top up your account and try again.
400InvalidParameterSpecified value of "Bandwidth" is not supported.The specified bandwidth value is invalid.
400Forbidden.ChargeTypeIsPrepaidIt?s forbidden to change prepaid EIP?s bandwidth by API. It can be changed on Aliyun web console.-
400IncorrectEipStatusCurrent elastic IP status does not support this operation.You cannot perform the operation when the specified EIP is in the current state.
400InvalidParameterThe parameter is invalid.The parameter value is invalid.
400InvalidBandwidth.OutOfMaxTrafficBindedOnNatgwThe bandwidth is out of max traffic binded on natgw.-
400QuotaExceeded.LargeSpecEipElastic IP address with large spec quota exceeded.-
400InvalidEipAddressName.MalformedThe specified Name is not valid.-
400ResourceQueryErrorThe specified resource is queried error.An error occurred while querying the specified resource.
400InvalidDescription.MalformedInvalid description.-
400SYSTEM.UNKNOWN.ERRORThe Account failed to create order.-
400Abs.InvalidBandwidth.MalformedSpecified value of Bandwidth is not supported.-
400InvalidEIPStatus.BizDisabledThe EIP has been locked.The error message returned because the EIP is locked.
400OperationFailed.SaleValidateValidate sale condition with subArticle failed.Failed to validate the sales condition with a subproject.
400OperationFailed.SyncOrderToSubSyncOrderToSub error.The operation failed.
400COMMODITY.INVALID_COMPONENTThe instance component is invalid.-
400OperationFailed.CompleteUserInfoComplete user info failed.-
400OperationFailed.ConcurrentRequestOperation failed because concurrent request.-
400IncorrectStatus.ResourceStatusResource status is abnormal for renew.-
400Forbidden.FinancialLockedThe ip business status is invalid.The error message returned because the instance has overdue payments.
404InvalidAllocationId.NotFoundSpecified 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.
404Forbidden.InCommonBandwidthPackageSpecified allocation ID in common bandwidth package.-
404Forbidden.RegionNotFoundSpecified region is not found during access authentication.The specified region does not exist. Check whether the specified region ID is valid.
500InternalErrorThe request processing has failed due to some unknown error.An unknown error occurred.
500InternalErrorThe 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 timeSummary of changesOperation
2023-11-09The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404
    delete Error Codes: 500
2023-07-24API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 500 change
    delete Error Codes: 400
    delete Error Codes: 404