Call the ModifyEipAddressAttributes interface to modify the name, description, and bandwidth limit of an elastic IP address (EIP).

Instructions

Decreasing maximum bandwidth may affect business traffic and lead to packet loss. Evaluate the possible impacts of the action on your business and proceed with caution.

If you do not configure the following optional parameters, their current values remain unchanged.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. More information can be found in Common parameters.

Action String required Example: ModifyEipAddressAttributes

The action that you want to perform. Value: ModifyEipAddressAttributes.

Version String required Example: 2020-04-01

API version. The current version is 2020-04-01.

AllocationId String required Example: eip-2zb7u8xscd****

The ID of the EIP.

You can call the DescribeEipAddresses API to query the EIP ID.

Name String optional Example: eip-1

The name of the EIP.

Length must be between 1 and 128 characters.

The name must start with a letter, Chinese character, or number. It may include periods (.), underscores (_), and hyphens (-).

DirectMode Boolean optional Example: false

Specify whether to enable the Direct mode when attaching an EIP. Type the enumerated values strictly in the case form as follows. Do not pass in other values.

false (default): Do not enable Direct.

true: Enable Direct.

tip

The EIP Direct feature is in the beta stage. To request a trial, please contact your account manager.

Description String optional Example: This is an eip

The description of the EIP.

The length limit is 0 to 255 characters.

Must start with a letter, Chinese character, or number. May include commas (,), periods (.), underscores (_), spaces ( ), equal signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).

Bandwidth Integer optional Example: 10

Maximum bandwidth of the EIP. Unit: Mbps.

Pay-by-data-transfer: Value ranges from 1 to 200.

Pay-by-bandwidth: Value ranges from 1 to 1000.

Subscription: Value ranges from 1 to 1000.

ReleaseWithInstance Boolean Optional Example: true

Describe whether to release the EIP along with the ECS instance.

true: Release the EIP when releasing the instance.

false: Do not release the EIP when releasing the instance.

Response parameters

The following only details response parameters specific to this API. More information can be found in Response structure.

RequestId String Example: 2021062415303301022514515207C4****

Request ID.

Request example

Response example

Error code

For common error codes, see Common error codes.

Status code	Error code	Error message	Explain
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	This request is set to DryRun action. The action has been authorized but has not been executed.
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	The parameters of this idempotent request are inconsistent with those used in the previous request.
400	InvaildIpv6.NotSupport	The specified IPv6 address does not support this operation.	The specified IPv6 address does not support this action.
400	InvalidBandwidth.Malformed	The specified bandwidth is malformed. During the temporary upgrade period, the bandwidth can only be greater。	The specified bandwidth is invalid. Ensure the value is not less than 1 when specifying bandwidth.
400	InvalidBandwidth.Malformed	The specified bandwidth is malformed.Ensure that bandwidth is not smaller than 1.	The specified bandwidth is invalid. During temporary upgrade, you can only increase bandwidth.
400	InvalidBillingType.Malformed	The specified billing type is malformed.	The specified billing method is invalid.
400	InvalidDescription.Malformed	The specified description is malformed.	The specified description format is invalid. The description cannot exceed 255 characters.
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	The specified description format is invalid. Correct the description format and retry.
400	InvalidDirectModeEip.EIPInBindedMode	EIP in binded mode can not be modified to direct mode.	EIPs in the BINDED mode cannot be modified to the pass-through mode.
400	InvalidDirectModeEip.IPv4GatewayEnabled	EIP not allowed to open direct mode when VPC has enabled IPv4 gateway.	The VPC has enabled the IPv4 gateway. Therefore, the EIP cannot enable pass-through mode.
400	InvalidDirectModeEip.InstanceMismatch	The specified instance type does not support direct mode EIP.	The specified instance type does not support pass-through EIP.
400	InvalidDirectModeEip.InvalidBindInstanceType	Only elastic network interface bound to ECS support associating direct mode EIP.	Only ENIs associated with ECSs support associating direct EIPs.
400	InvalidDirectModeEip.InvalidStatus	Only attached EIP support modifying direct mode.	Only associated EIPs support modifying Direct mode.
400	InvalidEip.InUse	The specified EIP is being operated by another request.	The specified EIP is being processed by another request. Try again later.
400	InvalidEip.InvalidStatus	The specified elastic ip is not in the correct status for the request.	The specified Elastic public IP or Virtual Private Cloud is in a status that cannot respond to this request. The current Elastic public IP is frozen.
400	InvalidEip.InvalidStatus	The specified elastic ip is not in the correct status for the request. The specified elastic ip is in freeze.	The specified Elastic public IP is in a state that cannot respond to this request.
400	InvalidEip.NotSupported	The specified elastic IP does not support temporary upgrade.	The specified EIP does not support temporary upgrades.
400	InvalidEni.InvalidStatus	The specified elastic network interface is not in the correct status for the request.	The specified Elastic Network Interface is not in a status that can respond to this request.
400	InvalidModeEip.DirectMode	EIP not allowed to open direct mode.	Direct mode cannot be enabled for the EIP.
400	InvalidName.Malformed	The specified name is malformed.	The format of the specified name is invalid. The name cannot exceed 128 characters.
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	The specified name format is invalid. Correct the name format and retry.
400	InvalidOperation.InvalidBindInstanceType	Only EIPs bound to ECS support releasing with instances.	The release with instance feature of the EIP is effective only if the EIP is associated with the ECS instance.
400	InvalidOperation.InvalidEipBillingType	Only postpaid EIPs support releasing with instances.	Only pay-as-you-go EIPs support the release-with-instance feature.
400	InvalidParameter	A parameter specified in the request is not valid, is unsupported or cannot be used.	The request contains invalid or unsupported parameters.
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	The specified ClientToken format is invalid. It cannot exceed 64 ASCII characters.
400	InvalidVpc.InvalidStatus	The specified VPC is not in the correct status for the request.	The specified VPC is in a state that cannot process this request.
400	LimitExceeded.BandwidthPerEip	You've reached the limit on the bandwidth of elastic ip that you can create.	The EIP bandwidth cap has been reached.
400	MissingParameter	The request is missing a required parameter.	This request does not contain required parameters.
400	OrderError	Failed to create an order in one step.	Failed to create and pay the order.
400	PreOrderError	Failed to create pre order.	Failed to create a configuration order.
400	UnsupportedOperation	The request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total.	The request to operate on this instance is rejected because the sum of both account balance and available coupons are less than CNY 100.
400	UnsupportedOperation	The request on the specified instance is denied due to the account in arrears status.	The action request on this instance is denied because the account is in arrears.
403	Forbidden	You are not authorized to perform operations on the specified EIP. The specified EIP is a service-managed EIP.	No permission to associate a pass-through EIP with an ECS instance.
403	Forbidden	You are not authorized to associate direct mode EIP with ECS.	No permission to operate the specified EIP. The specified EIP is an EIP managed by cloud products.
404	InvalidEip.GetInstanceDetail	Get instance detail failed.	Failed to obtain instance information.
404	InvalidEip.NotFound	The specified EIP does not exist.	The specified EIP does not exist.
404	InvalidEniId.NotFound	The specified elastic network interface does not exist.	The specified ENI does not exist.
409	InvalidOperation.Conflict	The specified resource operation conflicts.	The specified action on the resource conflicts.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The idempotent request is in process.
500	InternalError	An internal error has occurred.	An internal error occurred.

Elastic IP Address