调用DescribeRouterInterfaces接口查询指定地域内的路由器接口。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:DescribeRouterInterfaces | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 路由器接口所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
| IncludeReservationData | boolean | 否 | 是否包含续费数据。取值：
| false |
| PageNumber | integer | 否 | 列表的页码，默认值为 1。 | 1 |
| PageSize | integer | 否 | 分页查询时每页的行数，最大值为 50。默认值为 10。 | 10 |
| Filter | array<object> | 否 | 过滤信息。 | |
| object | 否 | 过滤信息。 | ||
| Key | string | 否 | 过滤条件，最多可提供 5 个过滤条件。支持以下过滤条件：
说明
每个过滤条件的多个值之间为或关系，即只要与其中一个值吻合则视为符合该过滤条件。各个过滤条件之间为与关系，即符合所有指定的过滤条件，才会进入最终的查询结果。
| Filter.1.Status |
| Value | array | 否 | 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值，每个过滤值之间是或的关系，即只要符合其中一个过滤值，则视为匹配该过滤条件。 | |
| string | 否 | 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值，每个过滤值之间是或的关系，即只要符合其中一个过滤值，则视为匹配该过滤条件。 | test | |
| ResourceGroupId | string | 否 | 资源组 ID。 关于资源组的更多信息，请参见什么是资源组。 | rg-acfmxazb4ph6aiy**** |
| Tags | array<object> | 否 | 资源的标签。 | |
| object | 否 | 标签。 | ||
| Key | string | 否 | 资源的标签键。至少输入 1 个标签键，最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
JSON格式
{
"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,
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"Tags": {
"Tags": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
]
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 参数非法 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 指定的RegionId不存在。请检查该参数是否正确。 |
| 404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | 该过滤器的Key不支持：Filter.X.key。 |
| 404 | InvalidRegionId.NotFound | The parameter wrong, pageNum or pageSize. | 参数错误 |
| 404 | InvalidRegionId.NotFound | The specified region does not exist. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-09-11 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-07-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-09-29 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-09-29 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |