Queries router interfaces in a region.

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 DescribeRouterInterfaces

The operation that you want to perform.

Set the value to DescribeRouterInterfaces.

RegionId String Yes cn-hangzhou

The ID of the region to which the router interface belongs.

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

IncludeReservationData Boolean No false

Specifies whether renewal data is included.

  • true: yes
  • false (default): no
PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Filter.N.Key String No Filter.1.status

The filter conditions. You can specify at most five filter conditions. Valid values of N: 1 to 20. The following filter conditions are supported:

  • RouterInterfaceId: the ID of the router interface.
  • RouterId: the ID of the router.
  • RouterType: the router type. Valid values: VRouter and VBR.
  • RouterInterfaceOwnerId: the ID of the Alibaba Cloud account to which the router interface belongs.
  • OppositeInterfaceId: the ID of the peer router interface.
  • OppositeRouterType: the type of the peer router interface. Valid values: VRouter and VBR.
  • OppositeRouterId: the ID of the peer router interface.
  • OppositeInterfaceOwnerId: the ID of the Alibaba Cloud account to which the peer router interface belongs.
  • Status: the status of the router interface.
  • Name: the name of the router interface.
Note The logical operator between multiple values in a filter condition is OR. In this case, the filter condition is met if one of the values is met. The logical operator between filter conditions is AND, which means that a result is returned only when all conditions are met.

Response parameters

Parameter Type Example Description
RequestId String C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45

The ID of the request.

PageNumber Integer 1

The page number of the returned page. Default value: 1.

PageSize Integer 10

The number of entries returned per page. Maximum value: 50. Default value: 10.

TotalCount Integer 2

The number of entries returned.

RouterInterfaceSet Array of RouterInterfaceType

The details about the router interface.

RouterInterfaceType
ReservationActiveTime String 2019-03-11T16:00:00Z

The time when the renewal takes effect.

HealthCheckTargetIp String 116.62.XX.XX

The destination IP address specified for health checks.

Note This parameter is required when the HealthCheckSourceIp parameter is set.
Status String active

The status of the router interface. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
CreationTime String 2018-05-28T08:15:00Z

The time when the router interface was created.

ReservationOrderType String RENEWCHANGE

The type of the renewal order.

OppositeInterfaceId String ri-2zeo3xzyf38r4urzd****

The ID of the peer router interface.

Spec String Mini.2

The specification of the router interface. Valid specifications and bandwidth values:

  • Mini.2: 2 Mbit/s
  • Mini.5: 5 Mbit/s
    • Small.1: 10 Mbit/s
    • Small.2: 20 Mbit/s
  • Small.5: 50 Mbit/s
    • Middle.1: 100 Mbit/s
    • Middle.2: 200 Mbit/s
    • Middle.5: 500 Mbit/s
    • Large.1: 1,000 Mbit/s
    • Large.2: 2,000 Mbit/s
    • Large.5: 5,000 Mbit/s
    • Xlarge.1: 10,000 Mbit/s
      Note When Role is set to AcceptingSide (acceptor), Spec is set to Negative.
ChargeType String PayByTraffic

The billing method.

RouterInterfaceId String ri-2zeo3xzyf38r4urz****

The ID of the router interface.

HcThreshold Integer 12

The healthy threshold.

OppositeRouterType String VRouter

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

  • VRouter: a vRouter
  • VBR: a virtual border router (VBR)
VpcInstanceId String vpc-2ze3tq4uxhysg717x****

The ID of the local virtual private cloud (VPC).

OppositeInterfaceOwnerId String 123157908552xxx

The ID of the Alibaba Cloud account to which the peer router interface belongs.

OppositeVpcInstanceId String vpc-bp1qpo0kug3a20qqe****

The ID of the peer VPC.

ReservationInternetChargeType String PayByBandwidth

The billing method that is used after the renewal takes effect.

CrossBorder Boolean false

Indicates whether the connection is a cross-border connection. Valid values:

  • false: no
  • true: yes
Bandwidth Integer 10

The bandwidth of the router interface. Unit: Mbit/s.

Description String abcabc

The description of the router interface.

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

HcRate Integer 2

The rate of heath checks.

ReservationBandwidth String 10

The bandwidth that is used after the renewal takes effect. Unit: Mbit/s.

Name String abc

The name of the router interface.

The name must be 2 to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. It cannot start with http:// or https://.

OppositeRouterId String vrt-bp1lhl0taikrteen8****vrt-bp1d3bxtdv68tfd7g****

The ID of the router to which the peer router interface belongs.

OppositeInterfaceSpec String Large

The specification of the peer router interface.

RouterId String vrt-bp1d3bxtdv68tfd7xxxx

The ID of the router to which the route entry belongs.

OppositeInterfaceBusinessStatus String Normal

The service status of the peer router interface. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
ConnectedTime String 2017-06-08T12:20:55

The time when the connection was established.

HealthCheckSourceIp String 116.62.XX.XX

The source IP address that is used to perform health checks. The source IP address must be an idle IP address of the local VPC.

Note You can set this parameter when an Express Connect circuit is used.
OppositeInterfaceStatus String Normal

The status of the peer router interface. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
EndTime String 2999-09-08T16:00:00Z

The end time of the retrieved data.

OppositeRegionId String cn-shanghai

The region where the peer router interface is located.

OppositeAccessPointId String ap-cn-shanghaiSZ-****

The ID of the peer access point.

Note This parameter is required when the peer router interface is associated with a VBR. The specified value cannot be changed after the router interface is created.
BusinessStatus String Normal

The service status of the router interface:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
OppositeBandwidth Integer 12

The bandwidth of the peer router interface. Unit: Mbit/s.

RouterType String VRouter

The type of the router to which the route table belongs. Valid values:

  • VRouter: a vRouter
  • VBR: a VBR
Role String InitiatingSide

The role of the router interface. Valid values:

  • InitiatingSide: connection initiator
  • AcceptingSide: connection acceptor
HasReservationData String false

Indicates whether renewal data is included. Valid values:

  • false: no
  • true: yes
AccessPointId String ap-cn-shanghaiSZ-****

The ID of the access point that is associated with the Express Connect circuit. You can call the DescribeAccessPoints operation to query the most recent access point list.

Ipv6Status String on

Indicates whether IPv6 protection is enabled. Valid values:

  • on: yes
  • off: no
  • unsupport: unsupported

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRouterInterfaces
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

<DescribeRouterInterfacesResponse>
    <RequestId>C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>2</TotalCount>
    <RouterInterfaceSet>
        <ReservationActiveTime>2019-03-11T16:00:00Z</ReservationActiveTime>
        <HealthCheckTargetIp>116.62.XX.XX</HealthCheckTargetIp>
        <Status>active</Status>
        <CreationTime>2018-05-28T08:15:00Z</CreationTime>
        <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
        <OppositeInterfaceId>ri-2zeo3xzyf38r4urzd****</OppositeInterfaceId>
        <Spec>Mini.2</Spec>
        <ChargeType>PayByTraffic</ChargeType>
        <RouterInterfaceId>ri-2zeo3xzyf38r4urz****</RouterInterfaceId>
        <HcThreshold>12</HcThreshold>
        <OppositeRouterType>VRouter</OppositeRouterType>
        <VpcInstanceId>vpc-2ze3tq4uxhysg717x****</VpcInstanceId>
        <OppositeInterfaceOwnerId>123157908552xxx</OppositeInterfaceOwnerId>
        <OppositeVpcInstanceId>vpc-bp1qpo0kug3a20qqe****</OppositeVpcInstanceId>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <CrossBorder>false</CrossBorder>
        <Bandwidth>10</Bandwidth>
        <Description>abcabc</Description>
        <HcRate>2</HcRate>
        <ReservationBandwidth>10</ReservationBandwidth>
        <Name>abc</Name>
        <OppositeRouterId>vrt-bp1lhl0taikrteen8****vrt-bp1d3bxtdv68tfd7g****</OppositeRouterId>
        <OppositeInterfaceSpec>Large</OppositeInterfaceSpec>
        <RouterId>vrt-bp1d3bxtdv68tfd7xxxx</RouterId>
        <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
        <ConnectedTime>2017-06-08T12:20:55</ConnectedTime>
        <HealthCheckSourceIp>116.62.XX.XX</HealthCheckSourceIp>
        <OppositeInterfaceStatus>Normal</OppositeInterfaceStatus>
        <EndTime>2999-09-08T16:00:00Z</EndTime>
        <OppositeRegionId>cn-shanghai</OppositeRegionId>
        <OppositeAccessPointId>ap-cn-shanghaiSZ-****</OppositeAccessPointId>
        <BusinessStatus>Normal</BusinessStatus>
        <OppositeBandwidth>12</OppositeBandwidth>
        <RouterType>VRouter</RouterType>
        <Role>InitiatingSide</Role>
        <HasReservationData>false</HasReservationData>
        <AccessPointId>ap-cn-shanghaiSZ-****</AccessPointId>
        <Ipv6Status>on</Ipv6Status>
    </RouterInterfaceSet>
</DescribeRouterInterfacesResponse>

JSON format

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

{
  "RequestId" : "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 2,
  "RouterInterfaceSet" : [ {
    "ReservationActiveTime" : "2019-03-11T16:00:00Z",
    "HealthCheckTargetIp" : "116.62.XX.XX",
    "Status" : "active",
    "CreationTime" : "2018-05-28T08:15:00Z",
    "ReservationOrderType" : "RENEWCHANGE",
    "OppositeInterfaceId" : "ri-2zeo3xzyf38r4urzd****",
    "Spec" : "Mini.2",
    "ChargeType" : "PayByTraffic",
    "RouterInterfaceId" : "ri-2zeo3xzyf38r4urz****",
    "HcThreshold" : 12,
    "OppositeRouterType" : "VRouter",
    "VpcInstanceId" : "vpc-2ze3tq4uxhysg717x****",
    "OppositeInterfaceOwnerId" : "123157908552xxx",
    "OppositeVpcInstanceId" : "vpc-bp1qpo0kug3a20qqe****",
    "ReservationInternetChargeType" : "PayByBandwidth",
    "CrossBorder" : false,
    "Bandwidth" : 10,
    "Description" : "abcabc",
    "HcRate" : 2,
    "ReservationBandwidth" : "10",
    "Name" : "abc",
    "OppositeRouterId" : "vrt-bp1lhl0taikrteen8****vrt-bp1d3bxtdv68tfd7g****",
    "OppositeInterfaceSpec" : "Large",
    "RouterId" : "vrt-bp1d3bxtdv68tfd7xxxx",
    "OppositeInterfaceBusinessStatus" : "Normal",
    "ConnectedTime" : "2017-06-08T12:20:55",
    "HealthCheckSourceIp" : "116.62.XX.XX",
    "OppositeInterfaceStatus" : "Normal",
    "EndTime" : "2999-09-08T16:00:00Z",
    "OppositeRegionId" : "cn-shanghai",
    "OppositeAccessPointId" : "ap-cn-shanghaiSZ-****",
    "BusinessStatus" : "Normal",
    "OppositeBandwidth" : 12,
    "RouterType" : "VRouter",
    "Role" : "InitiatingSide",
    "HasReservationData" : "false",
    "AccessPointId" : "ap-cn-shanghaiSZ-****",
    "Ipv6Status" : "on"
  } ]
}

Error codes

HttpCode Error code Error message Description
400 InvalidParam.NotNull The parameter must not be null. The error message returned because a required parameter is not set.
400 Parameter.Illegal The parameter is illegal. The error message returned because the parameter is set to an invalid value.
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key The error message returned because Filter.X.key is not supported.

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