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

Queries the configuration of a router interface.

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:DescribeRouterInterfaceAttribute

get

*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-qingdao
InstanceId	string	Yes	The ID of the router interface to query.	ri-m5egfc10sednwk2yt****

Response elements

Element	Type	Description	Example
	object	The response parameters.
ReservationActiveTime	string	The renewal active time. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2022-06-11T16:00:00Z
HealthCheckTargetIp	string	The health check target IP address.	2.2.XX.XX
Status	string	The status of the router interface. Valid values: Idle: not connected. AcceptingConnecting: accepting a connection. Connecting: connecting. Activating: being activated. Active: activated. Modifying: being modified. Deactivating: being frozen. Inactive: frozen. Deleting: being deleted.	Active
CreationTime	string	The time when the router interface was created. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2022-04-14T08:57:24Z
ReservationOrderType	string	The renewal order type. Valid values: RENEW, which indicates a renewal order.	RENEW
OppositeInterfaceId	string	The ID of the peer router interface.	ri-bp1xkrzttximaoxbl****
Spec	string	The specification of the router interface. Valid values: 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	Mini.2
ChargeType	string	The billing method. Valid values: AfterPay: pay-as-you-go. PrePaid: subscription.	AfterPay
RouterInterfaceId	string	The ID of the router interface.	ri-m5egfc10sednwk2yt****
Message	string	The returned message.	successful
HcThreshold	integer	The health check threshold. This value indicates the number of probe packets sent during a health check. Unit: packets.	8
OppositeRouterType	string	The type of the router to which the peer router interface belongs. Valid values: VRouter: vRouter of a VPC. VBR: Virtual Border Router.	VRouter
GmtModified	string	The time when the router interface was last modified.	2022-04-28T10:02:12Z
VpcInstanceId	string	The ID of the virtual private cloud (VPC) to which the router interface belongs.	vpc-bp1b49rqrybk45nio****
OppositeInterfaceOwnerId	string	The ID of the account to which the peer router interface belongs.	1321932713****
OppositeVpcInstanceId	string	The ID of the peer VPC.	vpc-bp1b49rqrybk45nio****
ReservationInternetChargeType	string	The renewal billing type. Valid values: PayByBandwidth, which indicates pay-by-bandwidth.	PayByBandwidth
CrossBorder	boolean	Indicates whether this is a cross-border connection. Valid values: false: No. true: Yes.	false
RequestId	string	The request ID.	01818199-04F6-47F4-9ADF-7CC824CF57A4
Bandwidth	integer	The bandwidth of the router interface. Unit: Mbps.	2
Description	string	The description of the router interface.	Peer interface
HcRate	integer	The health check rate. Unit: seconds. This value indicates the interval between consecutive probe packets sent during a health check.	2
ReservationBandwidth	string	The renewal bandwidth. Unit: Mbps.	100
Code	string	The HTTP status code.	200
Name	string	The name of the router interface.	RouterInterface1
OppositeRouterId	string	The ID of the router to which the peer router interface belongs.	vrt-bp11xvy6lb9photuu****
OppositeInterfaceSpec	string	The specification of the peer router interface. Valid values: 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 Negative: no specification involved.	Negative
RouterId	string	The ID of the router to which the router interface belongs.	vbr-m5ex0xf63xk8s5bob****
Success	boolean	Indicates whether the call was successful.	true
OppositeInterfaceBusinessStatus	string	The business status of the peer router interface. Valid values: Normal: normal. FinancialLocked: locked due to overdue payment. SecurityLocked: locked due to security risk control.	Normal
ConnectedTime	string	The time when the connection was established. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2022-04-14T08:58:04Z
HealthCheckSourceIp	string	The health check source IP address.	1.1.XX.XX
OppositeInterfaceStatus	string	The status of the peer router interface. Valid values: Idle: not connected. AcceptingConnecting: accepting a connection. Connecting: connecting. Activating: being activated. Active: activated. Modifying: being modified. Deactivating: being frozen. Inactive: frozen. Deleting: being deleted. Deleted: deleted.	Active
EndTime	string	The end time of the data retrieval. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2999-09-08T16:00:00Z
OppositeRegionId	string	The region ID of the peer router interface.	cn-hangzhou
OppositeAccessPointId	string	The ID of the peer access point.	ap-cn-qingdao-ls-B
BusinessStatus	string	The business status of the router interface. Valid values: Normal: normal. FinancialLocked: locked due to overdue payment. SecurityLocked: locked due to security risk control.	Normal
HealthCheckStatus	string	The health check status. Valid values: Abnormal: abnormal. Normal: normal. NoRedundantRoute: no redundant route configured. NoHealthCheckConfig: no health check configured.	normal
OppositeBandwidth	integer	The bandwidth of the peer router interface. Unit: Mbps.	0
RouterType	string	The type of the router to which the route table belongs. Valid values: VRouter: vRouter of a VPC. VBR: Virtual Border Router.	VRouter
Role	string	The role in the peering connection.	InitiatingSide
HasReservationData	string	Indicates whether renewal data exists. Valid values: false: No. true: Yes.	false
AccessPointId	string	The ID of the access point.	ap-cn-qingdao-ls-A
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. You must specify at least 1 tag key and can specify at most 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 64 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	The tag value of the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
FastLinkMode	string	Indicates whether the router interface on the VBR was created in fast link mode. Fast link mode allows the router interfaces on both the VBR and VPC sides to automatically connect after creation. Valid values: true: Yes. false (default): No. Note This parameter takes effect only when RouterType is set to VBR and OppositeRouterType is set to VRouter. When FastLinkMode is set to true, Role must be set to InitiatingSide, and AccessPointId, OppositeRouterType, OpppsiteRouterId, and OppositeInterfaceOwnerId are required.	false

Examples

Success response

JSON format

{
  "ReservationActiveTime": "2022-06-11T16:00:00Z",
  "HealthCheckTargetIp": "2.2.XX.XX",
  "Status": "Active",
  "CreationTime": "2022-04-14T08:57:24Z",
  "ReservationOrderType": "RENEW",
  "OppositeInterfaceId": "ri-bp1xkrzttximaoxbl****",
  "Spec": "Mini.2",
  "ChargeType": "AfterPay",
  "RouterInterfaceId": "ri-m5egfc10sednwk2yt****",
  "Message": "successful",
  "HcThreshold": 8,
  "OppositeRouterType": "VRouter",
  "GmtModified": "2022-04-28T10:02:12Z",
  "VpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "OppositeInterfaceOwnerId": "1321932713****",
  "OppositeVpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "ReservationInternetChargeType": "PayByBandwidth",
  "CrossBorder": false,
  "RequestId": "01818199-04F6-47F4-9ADF-7CC824CF57A4",
  "Bandwidth": 2,
  "Description": "Peer interface",
  "HcRate": 2,
  "ReservationBandwidth": "100",
  "Code": "200",
  "Name": "RouterInterface1",
  "OppositeRouterId": "vrt-bp11xvy6lb9photuu****",
  "OppositeInterfaceSpec": "Negative",
  "RouterId": "vbr-m5ex0xf63xk8s5bob****",
  "Success": true,
  "OppositeInterfaceBusinessStatus": "Normal",
  "ConnectedTime": "2022-04-14T08:58:04Z",
  "HealthCheckSourceIp": "1.1.XX.XX",
  "OppositeInterfaceStatus": "Active",
  "EndTime": "2999-09-08T16:00:00Z",
  "OppositeRegionId": "cn-hangzhou",
  "OppositeAccessPointId": "ap-cn-qingdao-ls-B",
  "BusinessStatus": "Normal",
  "HealthCheckStatus": "normal",
  "OppositeBandwidth": 0,
  "RouterType": "VRouter",
  "Role": "InitiatingSide",
  "HasReservationData": "false",
  "AccessPointId": "ap-cn-qingdao-ls-A",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Tags": {
    "Tags": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "FastLinkMode": "false"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.NotNull	The parameter must not be null.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.