All Products
Search

This Product

    Virtual Private Cloud:EnableVpcIpv4Gateway

    Document Center

    Virtual Private Cloud:EnableVpcIpv4Gateway

    Last Updated:Aug 28, 2026

    Activates an IPv4 gateway.

    Operation description

    Description

    • EnableVpcIpv4Gateway is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the GetIpv4GatewayAttribute operation to query the status of the IPv4 gateway.

      • If the IPv4 gateway is in the Activating state, it is being activated.

      • If the IPv4 gateway is in the Created state, it is activated.

    • You cannot repeatedly call the EnableVpcIpv4Gateway operation to activate an IPv4 gateway within a specific period of time.

    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
    Ipv4GatewayId

    string

    Yes

    The ID of the IPv4 gateway to activate.

    ipv4gw-5tsp9lumsxoqizvq2****
    RegionId

    string

    Yes

    The region ID of the IPv4 gateway.

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

    ap-southeast-6
    DryRun

    boolean

    No

    Specifies whether to perform a dry run without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.

    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

    false
    ClientToken

    string

    No

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

    You can use the client to generate the token, but you must ensure that the token is unique among 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 request ID may be different for each request.

    123e4567-e89b-12d3-a456-426655440000
    RouteTableList

    array

    No

    A list of route tables. The system adds a 0.0.0.0/0 route that points to the IPv4 gateway to the route tables.

    string

    No

    A list of route tables. The system adds a 0.0.0.0/0 route that points to the IPv4 gateway to the route tables. You can specify up to 10 route tables.

    Note

    The route table and the IPv4 gateway must belong to the same virtual private cloud (VPC).

    vtb-5ts0ohchwkp3dydt2****
    RegionId

    string

    Yes

    The region ID of the IPv4 gateway.

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

    ap-southeast-6

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    54B48E3D-DF70-471B-AA93-08E683A1B45

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE Specified CIDR block is already exists.
    400 ResourceNotFound.Ipv4Gateway The specified resource ipv4Gateway is not found. The IPv4 gateway is not found and cannot be deleted.
    400 IncorrectStatus.Ipv4Gateway The status of %s [%s] is incorrect. The IPv4 gateway is in an invalid state. Try again later.
    400 OperationFailed.Ipv4GatewayAlreadyActive. The operation failed because of ipv4Gateway is already active.
    400 OperationDenied.ConflictOfAllZeroRouting The operation is not allowed because of routetable [%s] exist all-zero route entry.
    400 UnsupportedFeature.Ipv4Gateway The feature of ipv4Gateway is not supported for [%s]. The system failed to create the IPv4 gateway because IPv4 gateways are not supported.
    400 OperationDenied.VpnExist The operation is not allowed because of existing vpn. You are not allowed to create an IPv4 gateway because a VPN gateway already exists in the VPC.
    400 OperationDenied.NatgatewayExist The operation is not allowed because of existing nat.
    400 OperationDenied.DirectEipExist The operation is not allowed because of existing directEip. EIPs are associated with the VPC in cut-through mode or enhanced NAT gateways are deployed in the VPC.
    400 OperationDenied.VpcHasAlreadyActive The operation is not allowed because of vpc has already been active.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.