ModifyEipForwardMode

Updated at: 2025-03-21 09:33

Modifies the EIP forwarding mode.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
OperationAccess levelResource typeCondition keyAssociated operation
vpc:ModifyEipForwardModeupdate
*Address
acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the EIP belongs. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
InstanceIdstringYes

The ID of the EIP whose attributes you want to modify.

eip-j5ebhbw3br92fy****
ModestringYes

The association mode. Valid values:

  • NAT (default): the standard NAT mode.
  • MULTI_BINDED: the multi-EIP-to-ENI mode.
  • BINDED: the cut-through mode.
Note
This parameter is required only if InstanceType is set to NetworkInterface.
BINDED
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.

Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The RequestId may be different for each request.
02fb3da4-130e-11e9-8e44-0016e04115b

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

62C6A6A5-1534-53D9-AB1E-C9307A147ED5

Examples

Sample success responses

JSONformat

{
  "RequestId": "62C6A6A5-1534-53D9-AB1E-C9307A147ED5"
}

Error codes

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
400Region.NotSupportRegion not support.-
400Instance.ModeErroreip instance mode error.-
400Instance.StatusErroreip status error.-
400ENI.BindEcseni bind ecs.-
400Forbidden.PrePaidBindedEipprepaid eip cannot be direct.-
400BindInstance.NotSupporteip can only change mode when it is allocated or bind eni.-
400Forbidden.PrePaidBindedEipPrepaid eip cannot be direct.-
400IncorrectStatus.EipInstanceEip instance's status is invalid.-
403ForbiddenUser not authorized to operate on the specified resource.You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404Instance.NotFoundeip instance not found.-
404ENI.NotFoundeni not found.-

For a list of error codes, visit the Service error codes.

  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
Feedback