Call ModifyEipAddressAttribute to change the name, description, and bandwidth of an EIP - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Modifies the name, description, and peak bandwidth of a specified elastic IP address (EIP).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:ModifyEipAddressAttribute

update

*Address

acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}

None

Request parameters

Parameter	Type	Required	Description	Example
AllocationId	string	Yes	The ID of the pay-as-you-go EIP that you want to modify.	eip-2zeerraiwb7uj6i0d****
Bandwidth	string	No	The peak bandwidth of the EIP. Valid values: 1 to 200: if the EIP uses the pay-by-data-transfer billing method. Unit: Mbit/s. 1 to 500: if the EIP uses the pay-by-bandwidth billing method. Unit: Mbit/s.	100
RegionId	string	No	The region ID of the EIP. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
Name	string	No	The name of the EIP. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	Test123
Description	string	No	The description of the EIP. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	abc

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InsufficientBalance.Eip	Your account does not have enough balance.
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.
400	InvalidParameter	The parameter is invalid.	The bandwidth 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	InvalidDescription.Malformed	Invalid description.
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	MissingParam.InstanceId	The parameter InstanceId is mandatory.	You must specify the Express Connect circuit ID.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidAllocationId.NotFound	Specified allocation id is not found.
404	Forbidden.InCommonBandwidthPackage	Specified allocation ID in common bandwidth package.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.