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 region ID of the router interface.

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. 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.
Filter.N.Value.N RepeatList No Filter.1.Active 1

The filter values of keys. You can specify multiple filter values for one key. The logical operator between filter values is OR. If one filter value is matched, the filter condition is matched.

Response parameters

Parameter Type Example Description
TotalCount Integer 2

The number of returned entries.

PageNumber Integer 1

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

PageSize Integer 10

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

RequestId String C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45

The ID of the request.

RouterInterfaceSet Array of RouterInterfaceType

The details about the router interface.

RouterInterfaceType
AccessPointId String ap-cn-shanghaiSZ-****

The ID of the access point.

Bandwidth Integer 10

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

BusinessStatus String Normal

The service status of the router interface:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
ChargeType String PayByTraffic

The billing method.

ConnectedTime String 2017-06-08T12:20:55

The time when the connection was established.

CreationTime String 2017-06-08T12:20:55

The time when the route table was created.

CrossBorder Boolean false

Indicates whether the connection is a cross-border connection.

Description String The description of the router interface.

The description of the router interface.

EndTime String 2017-06-08T12:20:55

The end time of the retrieved data.

HasReservationData String false

Indicates whether renewal data is included.

HcRate Integer 1

The rate of heath checks.

HcThreshold Integer 2

The number of consecutive health check successes before a backend server is declared as healthy.

HealthCheckSourceIp String 116.62.XX.XX

The source IP address specified for health checks.

HealthCheckTargetIp String 116.62.XX.XX

The destination IP address specified for health checks.

Name String test

The custom name.

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

The ID of the peer access point.

OppositeBandwidth Integer 12

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

OppositeInterfaceBusinessStatus String Normal

The service status of the peer router interface.

OppositeInterfaceId String ri-bp1itx13bwe6f2wfh****

The ID of the peer router interface.

OppositeInterfaceOwnerId String 123157908552****

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

OppositeInterfaceSpec String Large

The specification of the peer router interface.

OppositeInterfaceStatus String Normal

The status of the peer router interface.

OppositeRegionId String cn-shanghai

The region ID of the peer router interface.

OppositeRouterId String vrt-bp1d3bxtdv68tfd7g****

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

OppositeRouterType String VRouter

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

OppositeVpcInstanceId String vpc-bp1qpo0kug3a20qqe****

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

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

The time when the renewal takes effect.

ReservationBandwidth String 10

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

ReservationInternetChargeType String PayByBandwidth

The billing method after the renewal takes effect.

ReservationOrderType String RENEWCHANGE

The type of the renewal order.

Role String InitiatingSide

The role of the router interface in the peering connection.

RouterId String vrt-bp1d3bxtdv68tfd7g****

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

RouterInterfaceId String ri-2zenfgfpyu3v93koa****

The ID of the router interface.

RouterType String VRouter

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

  • VRouter: a VPC router.
  • VBR: a virtual border router (VBR).
Spec String Large

The specification of the router interface.

Status String active

The status of the router interface.

VpcInstanceId String vpc-2ze3tq4uxhysg717x****

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

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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

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 specified.
400 Parameter.Illegal The parameter is illegal. The error message returned because the parameter is invalid.
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.