DescribeRouterInterfaces - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeRouterInterfaces for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

get

*RouterInterface

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. You can call the `DescribeRegions` operation to get the latest list of regions.
PageNumber	integer	No	The page number. Page numbering starts from 1. Default: 1.
PageSize	integer	No	The number of entries to return per page. Valid values: 1 to 100. Default: 10.
Filter	array<object>	No	The filters.
	object	No
Key	string	No	The filter key. Supported values: `RouterInterfaceId`: The ID of the router interface. `RouterId`: The ID of the router that the router interface is attached to. `RouterType`: The type of the router. Valid values: `VRouter` and `VBR`. `Status`: The status of the router interface. `Name`: The name of the router interface. `Role`: The role of the router interface. Valid values: `InitiatingSide` and `AcceptingSide`.
Value	array	No	The values for the filter key. You can specify a maximum of 20 values.
	string	No

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.
PageNumber	integer	The page number.
PageSize	integer	The number of entries per page.
TotalCount	integer	The total number of entries.
RouterInterfaceSet	object	Details of the router interfaces.
RouterInterfaceType	array<object>	An array of router interfaces.
	object
HealthCheckTargetIp	string	The target IP address for the health check.
CreationTime	string	The time when the router interface was created. The time is in UTC and is formatted as `YYYY-MM-DDThh:mm:ssZ`.
Status	string	The status of the router interface. Valid values: `Idle` `Activating` `Active` `Deactivating` `Inactive` `Deleting`
Spec	string	The specification of the router interface.
OppositeInterfaceId	string	The ID of the opposite router interface.
RouterInterfaceId	string	The ID of the router interface.
ChargeType	string	The billing method of the router interface. Valid values: PostPaid: pay-as-you-go PrePaid: subscription
OppositeRouterType	string	The type of the opposite router. Valid values: `VRouter` `VBR`
OppositeInterfaceOwnerId	string	The ID of the account that owns the opposite router interface.
Description	string	The description of the router interface.
Name	string	The name of the router interface.
OppositeRouterId	string	The ID of the opposite router.
OppositeInterfaceSpec	string	The specification of the opposite router interface.
RouterId	string	The ID of the router to which the router interface belongs.
OppositeInterfaceBusinessStatus	string	The business status of the opposite router interface. Valid values: `Normal` `FinancialLocked` `SecurityLocked`
ConnectedTime	string	The time when the connection was established. The time is in UTC and is formatted as `YYYY-MM-DDThh:mm:ssZ`.
OppositeInterfaceStatus	string	The status of the opposite router interface.
HealthCheckSourceIp	string	The source IP address for the health check.
EndTime	string	The expiration time of the subscription-based router interface. This parameter is returned only if `ChargeType` is set to `PrePaid`. The time is in UTC and is formatted as `YYYY-MM-DDThh:mm:ssZ`.
OppositeRegionId	string	The region ID of the opposite router interface.
OppositeAccessPointId	string	The ID of the opposite access point.
BusinessStatus	string	The business status of the router interface. Valid values: `Normal` `FinancialLocked` `SecurityLocked`
Role	string	The role of the router interface in the connection. Valid values: `InitiatingSide`: initiator `AcceptingSide`: acceptor
RouterType	string	The type of the router to which the router interface belongs. Valid values: `VRouter` `VBR`
AccessPointId	string	The ID of the access point.

Examples

Success response

JSON format

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "HealthCheckTargetIp": "",
        "CreationTime": "",
        "Status": "",
        "Spec": "",
        "OppositeInterfaceId": "",
        "RouterInterfaceId": "",
        "ChargeType": "",
        "OppositeRouterType": "",
        "OppositeInterfaceOwnerId": "",
        "Description": "",
        "Name": "",
        "OppositeRouterId": "",
        "OppositeInterfaceSpec": "",
        "RouterId": "",
        "OppositeInterfaceBusinessStatus": "",
        "ConnectedTime": "",
        "OppositeInterfaceStatus": "",
        "HealthCheckSourceIp": "",
        "EndTime": "",
        "OppositeRegionId": "",
        "OppositeAccessPointId": "",
        "BusinessStatus": "",
        "Role": "",
        "RouterType": "",
        "AccessPointId": ""
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.NotNull	The parameter must not be null.	The parameter is required.
400	IllegalParam.AliUid	Specified value of aliuid invalid.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key
404	InvalidOppositeRegionId.NotFound	The oppositeRegionId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.