DescribeRouterInterfaces API Reference - Express Connect - Alibaba Cloud - Express Connect

Queries router interfaces in a specified region.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeRouterInterfaces

list

*RouterInterface

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the router interface. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
IncludeReservationData	boolean	No	Specifies whether to include renewal data. Valid values: true false (default)	false
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page when paging is performed. Maximum value: 50. Default value: 10.	10
Filter	array<object>	No	The filter information.
	object	No	The filter information.
Key	string	No	The filter condition. You can specify up to 5 filter conditions. The following filter conditions are supported: RouterInterfaceId: the router interface ID. RouterId: the router ID. RouterType: the router type. Valid values: VRouter and VBR. RouterInterfaceOwnerId: the ID of the account to which the router interface belongs. OppositeInterfaceId: the peer router interface ID. OppositeRouterType: the peer router interface type. Valid values: VRouter and VBR. OppositeRouterId: the peer router interface ID. OppositeInterfaceOwnerId: the ID of the account to which the peer router interface belongs. Status: the router interface status. Name: the router interface name. Note The multiple values of each filter condition have an OR relationship. A router interface is returned as long as it matches one of the values. The filter conditions have an AND relationship. A router interface is returned only when it matches all specified filter conditions.	Filter.1.Status
Value	array	No	The filter value based on the specified Key. You can specify multiple filter values for a Key. The filter values have an OR relationship. A router interface is returned as long as it matches one of the filter values.	Filter.1.Active 1
	string	No	The filter value based on the specified Key. You can specify multiple filter values for a Key. The filter values have an OR relationship. A router interface is returned as long as it matches one of the filter values.	test
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	No	The tags of the resource.
	object	No	The tag.
Key	string	No	The tag key of the resource. You must specify at least 1 tag key and can specify up to 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumber	integer	The page number. Default value: 1.	1
PageSize	integer	The number of entries per page when paging is performed. Maximum value: 50. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	1
RouterInterfaceSet	object
RouterInterfaceType	array<object>	The details of the router interfaces.
	array<object>	The details of the router interfaces.
ReservationActiveTime	string	The renewal active time. The time follows the ISO 8601 standard in UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-03-11T16:00:00Z
HealthCheckTargetIp	string	The health check target IP address.	116.62.XX.XX
Status	string	The status of the router interface.	active
CreationTime	string	The time when the route table was created. The time follows the ISO 8601 standard in UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
ReservationOrderType	string	The renewal order type.	RENEWCHANGE
OppositeInterfaceId	string	The peer router interface ID.	ri-bp1itx13bwe6f2wfh****
Spec	string	The specification of the router interface.	Large
ChargeType	string	The billing method.	PayByTraffic
RouterInterfaceId	string	The router interface ID.	ri-2zenfgfpyu3v93koa****
HcThreshold	integer	The health check threshold.	2
OppositeRouterType	string	The type of the router to which the peer router interface belongs.	VRouter
VpcInstanceId	string	The ID of the local VPC in the peering connection.	vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerId	string	The ID of the account to which the peer router interface belongs.	271598332402530847
OppositeVpcInstanceId	string	The ID of the peer VPC.	vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeType	string	The renewal billing type.	PayByBandwidth
CrossBorder	boolean	Indicates whether the connection is a cross-border connection.	false
Bandwidth	integer	The bandwidth of the router interface. Unit: Mbit/s.	10
Description	string	The description of the router interface.	Router interface description
HcRate	integer	The health check rate.	1
ReservationBandwidth	string	The renewal bandwidth. Unit: Mbit/s.	10
Name	string	The custom name.	test
OppositeRouterId	string	The ID of the router to which the peer router interface belongs.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpec	string	The specification of the peer router interface.	Large
RouterId	string	The ID of the router to which the route entry belongs.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatus	string	The business status of the peer router interface.	Normal
ConnectedTime	string	The time when the connection was established. The time follows the ISO 8601 standard in UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
HealthCheckSourceIp	string	The health check source IP address.	116.62.XX.XX
OppositeInterfaceStatus	string	The status of the peer router interface.	Normal
EndTime	string	The end time of the retrieved data. The time follows the ISO 8601 standard in UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
OppositeRegionId	string	The region ID of the peer router interface.	cn-shanghai
OppositeAccessPointId	string	The peer access point ID.	ap-cn-shanghaiSZ-****
BusinessStatus	string	The business status of the router interface. Valid values: Normal: Normal. FinancialLocked: financial lock. SecurityLocked: locked due to security risk control.	Normal
OppositeBandwidth	integer	The peer bandwidth. Unit: Mbit/s.	12
RouterType	string	The type of the router to which the route table belongs. Valid values: VRouter: VPC vRouter. VBR: Virtual Border Router.	VRouter
Role	string	The role in the peering connection.	InitiatingSide
HasReservationData	string	Indicates whether renewal data exists.	false
AccessPointId	string	The access point ID.	ap-cn-shanghaiSZ-****
Ipv6Status	string	Indicates whether IPv6 security protection is enabled. Valid values: on: enabled. off: disabled. unsupport: not supported.	on
FastLinkMode	boolean	Indicates whether the router interface on the VBR was created in fast link mode. Fast link mode enables the router interfaces on the VBR and VPC to automatically connect after they are created. Valid values: true false (default)	false
ResourceGroupId	string	The resource group ID. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	The tags of the resource.
	object	The tag.
Key	string	The tag key of the resource.	FinanceDept
Value	string	The tag value of the resource.	FinanceJoshua

Examples

Success response

JSON format

{
  "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": "Router interface 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,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.NotNull	The parameter must not be null.
400	EndPoint.Empty	the rc endpoint is empty.
400	InvalidConnectionType.MalFormed	Connection type must be vpc2vpc or vbr2vpc.
400	InvalidProductForm.MalFormed	Product form must be routerinterface or expressconnect.
400	InvalidRole.Malformed	role must be InitiatingSide or AcceptingSide.
400	IllegalParam.AliUid	Specified value of aliuid invalid.
400	Parameter.Illegal	The parameter is illegal.	The parameter is invalid.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region does not exist.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	The parameter is invalid.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	Filter.X.key is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.