All Products
Search
Document Center

Virtual Private Cloud:DescribeRouterInterfaces

Last Updated:Dec 02, 2023

Queries router interfaces in a specified region.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeRouterInterfacesList
  • RouterInterface
    acs:vpc:{#regionId}:{#accountId}:routerinterface/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the router interface.

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

cn-hangzhou
IncludeReservationDatabooleanNo

Specifies whether renewal data is included. Default value: false. Valid values:

  • true
  • false
false
PageNumberintegerNo

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

1
PageSizeintegerNo

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

10
Filterobject []No
KeystringNo

The filter conditions. You can specify up to 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.
  • 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 the filter condition is OR. In this case, the filter condition is met if one of the values is matched. The logical operator between filter conditions is AND, which means that a result is returned only when all conditions are met.
Filter.1.Status
ValuearrayNo
stringNo

Specifies the value in the filter condition based on the key. You can specify multiple values in the filter condition for one key. The logical operator between multiple values in the filter condition is OR. If one value in the filter condition is matched, the filter condition is met.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumberinteger

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

1
PageSizeinteger

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

10
TotalCountinteger

The total number of entries returned.

1
RouterInterfaceSetobject []

The details of the router interface.

ReservationActiveTimestring

The time when the renewal takes effect.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

2021-03-11T16:00:00Z
HealthCheckTargetIpstring

The destination IP address that is used for the health check.

116.62.XX.XX
Statusstring

The status of the router interface.

active
CreationTimestring

The time when the route table was created.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

2021-06-08T12:20:55
ReservationOrderTypestring

The type of the renewal order.

RENEWCHANGE
OppositeInterfaceIdstring

The ID of the peer router interface.

ri-bp1itx13bwe6f2wfh****
Specstring

The specification of the router interface.

Large
ChargeTypestring

The metering method.

PayByTraffic
RouterInterfaceIdstring

The ID of the router interface.

ri-2zenfgfpyu3v93koa****
HcThresholdinteger

The health check threshold.

2
OppositeRouterTypestring

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

VRouter
VpcInstanceIdstring

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

vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerIdstring

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

271598332402530847
OppositeVpcInstanceIdstring

The ID of the peer VPC.

vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeTypestring

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

PayByBandwidth
CrossBorderboolean

Indicates whether the connection is a cross-border connection.

false
Bandwidthinteger

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

10
Descriptionstring

The description of the router interface.

HcRateinteger

The rate of the heath check.

1
ReservationBandwidthstring

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

10
Namestring

The custom name.

test
OppositeRouterIdstring

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

vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpecstring

The specification of the peer router interface.

Large
RouterIdstring

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

vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatusstring

The service status of the peer router interface.

Normal
ConnectedTimestring

The time when the connection was established.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

2021-06-08T12:20:55
HealthCheckSourceIpstring

The source IP address that is used for the health check.

116.62.XX.XX
OppositeInterfaceStatusstring

The status of the peer router interface.

Normal
EndTimestring

The end of the time range queried.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

2021-06-08T12:20:55
OppositeRegionIdstring

The region ID of the peer router interface.

cn-shanghai
OppositeAccessPointIdstring

The ID of the peer access point.

ap-cn-shanghaiSZ-****
BusinessStatusstring

The service status of the router interface. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
Normal
OppositeBandwidthinteger

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

12
RouterTypestring

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

  • VRouter
  • VBR
VRouter
Rolestring

Indicates whether the router interface is the initiator or acceptor of the peering connection.

InitiatingSide
HasReservationDatastring

Indicates whether renewal data is included.

false
AccessPointIdstring

The ID of the access point.

ap-cn-shanghaiSZ-****
Ipv6Statusstring

Indicates whether protection against malicious IPv6 traffic is enabled. Valid values:

  • on
  • off
  • unsupport
on
FastLinkModeboolean

Indicates whether the VBR that is created in the Fast Link mode is uplinked to the router interface. The Fast Link mode helps automatically connect router interfaces that are created for the VBR and its peer VPC. Default value: false. Valid values:

  • true
  • false
false

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParam.NotNullThe parameter must not be null.A required parameter is not specified.
400EndPoint.Emptythe rc endpoint is empty.-
400InvalidConnectionType.MalFormedConnection type must be vpc2vpc or vbr2vpc.-
400InvalidProductForm.MalFormedProduct form must be routerinterface or expressconnect.-
400InvalidRole.Malformedrole must be InitiatingSide or AcceptingSide.-
400IllegalParam.AliUidSpecified value of aliuid invalid.-
400Parameter.IllegalThe parameter is illegal.The parameter is invalid.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
404InvalidFilterKey.ValueNotSupportedSpecified filter key is not supported: Filter.X.keyFilter.X.key is not supported.
404InvalidRegionId.NotFoundThe parameter wrong, pageNum or pageSize.The parameter is set to an invalid value.
404InvalidRegionId.NotFoundThe specified region does not exist.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-11API Description Update,The API operation is not deprecated.,The error codes of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
API Deprecation DescriptionThe API operation is not deprecated.
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 404
2023-07-20The error codes of the API operation change.,The input parameters of the API operation change.,The response structure of the API operation changes.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: ResourceGroupId
    Added Input Parameters: Tags
Output ParametersThe response structure of the API operation changes.
2021-09-29The error codes of the API operation change.,The response structure of the API operation changes.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 404
Output ParametersThe response structure of the API operation changes.
2021-09-29The error codes of the API operation change.,The response structure of the API operation changes.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 404
Output ParametersThe response structure of the API operation changes.