All Products
Search

This Product

    Elastic IP Address:ModifyEipForwardMode

    Document Center

    Elastic IP Address:ModifyEipForwardMode

    Last Updated:Aug 28, 2026

    Modifies the forwarding mode of an 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the EIP. Call the DescribeRegions operation to query the most recent region list.

    cn-hangzhou
    InstanceId

    string

    Yes

    The ID of the EIP to modify.

    eip-j5ebhbw3br92fy****
    Mode

    string

    Yes

    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
    RegionId

    string

    Yes

    The region ID of the EIP. Call the DescribeRegions operation to query the most recent region list.

    cn-hangzhou
    ClientToken

    string

    No

    A client token that ensures the idempotence of the request.

    You can use the client to generate the token. The token must be unique among requests and 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 elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    62C6A6A5-1534-53D9-AB1E-C9307A147ED5

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Region.NotSupport Region not support.
    400 Instance.ModeError eip instance mode error.
    400 Instance.StatusError eip status error.
    400 ENI.BindEcs eni bind ecs.
    400 Forbidden.PrePaidBindedEip prepaid eip cannot be direct.
    400 BindInstance.NotSupport eip can only change mode when it is allocated or bind eni.
    400 IncorrectStatus.EipInstance Eip instance's status is invalid.
    403 Forbidden User 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.
    404 Instance.NotFound eip instance not found.
    404 ENI.NotFound eni not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.