Modifies the name, description, and maximum bandwidth of a pay-as-you-go elastic IP address (EIP). You cannot call this operation to modify the name, description, or maximum bandwidth of a subscription EIP.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyEipAddressAttribute

The operation that you want to perform. Set the value to ModifyEipAddressAttribute.

AllocationId String Yes eip-2zeerraiwb7uj6i0d****

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

Bandwidth String No 100

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.
RegionId String No cn-hangzhou

The region ID of the EIP.

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

Name String No Test123

The new name of the EIP.

The name must be 1 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

Description String No abc

The new description of the EIP.

The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.

Response parameters

Parameter Type Example Description
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyEipAddressAttribute
&AllocationId=eip-2zeerraiwb7uj6i0d****
&Bandwidth=100
&RegionId=cn-hangzhou
&Name=Test123
&Description=abc
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyEipAddressAttributeResponse>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</ModifyEipAddressAttributeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 OrderError.EIP The Account failed to create order. The error message returned because the system failed to generate the order.
400 InsufficientBalance.Eip Your account does not have enough balance. The error message returned because you do not have sufficient balance within your Apsara Stack tenant account. Top up your Apsara Stack tenant account and try again.
400 InvalidParameter Specified value of "Bandwidth" is not supported. The error message returned because the specified bandwidth value is invalid.
400 IncorrectEipStatus Current elastic IP status does not support this operation. The error message returned because you cannot perform the operation when the specified EIP is in the current state.
400 InvalidParameter The parameter is invalid. The error message returned because the parameter is set to an invalid value.
404 InvalidAllocationId.NotFound Specified allocation ID is not found The error message returned because the specified EIP does not exist. Check whether the specified value is valid.
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.RegionNotFound Specified region is not found during access authentication. The error message returned because 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. The error message returned because some unknown errors occurred.

For a list of error codes, visit the API Error Center.