Queries router interfaces in a specified region.
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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 most recent region list. | cn-hangzhou |
| IncludeReservationData | boolean | No | Specifies whether renewal data is included. Valid values:
| false |
| PageNumber | integer | No | The page number. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Maximum value: 50. Default value: 10. | 10 |
| Filter | array<object> | No | The filter information. | |
| object | No | |||
| Key | string | No | The filter conditions. You can specify up to five filter conditions. The following filter conditions are supported:
Note
The logical operator among multiple values in a filter condition is OR. In this case, the filter condition is met if one of the values is matched. The logical operator among filter conditions is AND. Only routers that meet all the filter conditions are queried.
| Filter.1.Status |
| Value | array | No | Specifies the value in the filter condition based on the key. You can specify multiple filter values for one key. The logical operator among filter values is OR. If one filter value is matched, the filter condition is matched. | |
| string | No | Specifies the value in the filter condition based on the key. You can specify multiple filter values for one key. The logical operator among filter values is OR. If one filter value is matched, the filter condition is matched. | test | |
| ResourceGroupId | string | No | Resource Group ID. For more information about resource groups, please refer to What is a Resource Group? | rg-acfmxazb4ph6aiy**** |
| Tags | array<object> | No | The tags of the resource. | |
| object | No | |||
| Key | string | No | The key of the resource tag. At least one tag key must be entered, and a maximum of 20 tag keys are supported. If this value needs to be passed in, it cannot be an empty string. A tag key can support up to 128 characters, cannot start with 'aliyun' or 'acs:', and cannot contain 'http://' or 'https://'. | FinanceDept |
| Value | string | No | The value of the resource tag. A maximum of 20 tag values can be entered. If this value needs to be passed in, an empty string can be entered. A maximum of 128 characters are supported, it cannot start with 'aliyun' or 'acs:', and it cannot contain 'http://' or 'https://'. | FinanceJoshua |
Response parameters
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": "The description of the router interface.",
"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. | A required parameter is not specified. |
| 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. |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | The RegionId parameter is set to an invalid value. Specify a valid value and try again. |
| 404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | Filter.X.key is not supported. |
| 404 | InvalidRegionId.NotFound | The parameter wrong, pageNum or pageSize. | The parameter is set to an invalid value. |
| 404 | InvalidRegionId.NotFound | The specified region does not exist. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-09-11 | API Description Update. The API operation is not deprecated.. The Error code has changed | View Change Details |
| 2023-07-20 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2021-09-29 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2021-09-29 | The Error code has changed. The response structure of the API has changed | View Change Details |