Create a router interface.

When calling this API to create a router interface, note:
  • Up to one pair of interconnected router interfaces can be created between two VRouters.

  • Up to five router interfaces can be created for a VRouter.

  • If there is a delinquent router interface in your account, you can no longer create router interfaces.

  • The destination CIDR blocks of (DestinationCidrBlock) of the route entries in the same route table cannot be the same.

  • The router interface created for a Virtual Border Router (VBR) must act as the connection initiator.

Request parameters

Name Type Required Description
Action String Yes

The action to perform. Valid value:

CreateRouterInterface

RegionId String Yes

The region of the router interface.

You can obtain the region ID by calling the DescribeRegions API.

RouterType String Yes

The type of the router associated with the router interface. Valid values:

  • VRouter: VRouter

  • VBR: VBR

AccessPointId String No

The ID of the access point to which the VBR belongs.

You can obtain the region ID by calling the DescribeAccessPoints API.

Note You must specify this parameter in the scenario of physical access.
RouterId String Yes

The ID of the router associated with the router interface.

Role String Yes

The role of the router interface. Valid value:

  • InitiatingSide: Connection initiator.

  • AcceptingSide: Connection receiver.

Spec String Yes

The specification of the router interface. The following are available specifications and the corresponding bandwidths:

  • Mini. 2: 2 Mbps

  • Mini. 5: 5 Mbps

  • Small 1: 10 Mbps

  • Small 2: 20 Mbps

  • Small 5: 50 Mbps

  • Middle. 1: 100 Mbps

  • Middle. 2: 200 Mbps

  • Middle. 5: 500 Mbps

  • Large. 1: 1000 Mbps

  • Large. 2: 2000 Mbps

  • Large. 5: 5000 Mbps

  • Xlarge. 1: 10000 Mbps

    Note The value of Spec is Negative when the role is AcceptingSide.
OppositeRegionId String Yes

The region of the connection receiver.

OppositeAccessPointId String No The ID of the access point of the peer router interface.
Note This parameter is required when the peer router interface is on a VBR and cannot be modified after the router interface is created.
OppositeRouterType String No

The type of the router associated with the peer router interface. Valid values:

  • VRouter: VRouter

  • VBR: VBR

OppositeRouterId String No

The ID of the peer router.

OppositeInterfaceId String No

The ID of the peer router interface.

OppositeInterfaceOwnerId String No

The ID of the owner of the peer router interface.

HealthCheckSourceIp String No

The source IP address used to perform health check. It must be an unused IP address of the local VPC.

Note You can specify this parameter in the scenario of physical access.
HealthCheckTargetIp String No

The destination IP address of health check.

Note This parameter is required when the HealthCheckSourceIp parameter is specified.
Name String No

The name of the router interface.

The name can contain 2-128 characters including a-z, A-Z, 0-9, periods, underscores, and hyphens. It must start with English letters, but cannot start with http:// or https://.

Description String No

The description of the router interface.

The description can contain 2-256 characters. It must start with English letters, but cannot start with http:// or https://.

InstanceChargeType String No

The billing method of the router interface. Valid values:

  • PostPaid (default): Pay-As-You-Go

ClientToken String No

A client token used to guarantee the idempotence of requests.

This parameter value is generated by the client and is guaranteed to be unique among different requests. The maximum length is 64 ASCII characters.

Response parameters

Name Type Description
RequestId String The ID of the request.
RouterInterfaceId String The ID of the router interface.
OrderId String The order number. This parameter is returned only when you select the Subscription billing mode.

Examples

Request example

https://vpc.aliyuncs.com/?Action=CreateRouterInterface
&RegionId=cn-beijing
&Role=InitiatingSide
&OppositeRegionId=cn-beijing
&Spec=Mini. 5
&RouterType=VRouter
&RouterId=vrt-2zepuy8qbrq6yhdje53t6
&OppositeRouterId= vrt-2zefso23vmu6xi3jeiw0z
&CommonParameters
Response example
  • XML format

    <? xml version="1.0" encoding="UTF-8"? >
    <CreateRouterInterfaceResponse>
        <RequestId>980960B0-2969-40BF-8542-EBB34FD358AB</RequestId>
        <RouterInterfaceId>ri-2ze7fbuohmxxxxxx</RouterInterfaceId>
    </CreateRouterInterfaceResponse>
  • JSON format

    { 
        "RequestId": "980960B0-2969-40BF-8542-EBB34FD358AB"
        "RouterInterfaceId": "ri-2ze7fbuohmxxxxxx"
    }