调用DescribeRouterInterfaces接口查询指定地域内的路由器接口。

您可以通过以下过滤条件对结果进行过滤。每个过滤条件的多个值之间是“or”关系，即只要与其中一个值吻合则视为符合该过滤条件。各个过滤条件之间为“and”关系，即符合所有指定的过滤条件，才会进入最终的查询结果。

  • RouterInterfaceId：路由器接口ID。
  • RouterId：路由器ID。
  • RouterType：路由器类型，取值：VRouter| VBR。
  • RouterInterfaceOwnerId：路由器接口的所属账号ID。
  • OppositeInterfaceId：对端路由器接口ID。
  • OppositeRouterType：对端路由器接口类型，取值：VRouter | VBR。
  • OppositeRouterId：对端路由器接口ID。
  • OppositeInterfaceOwnerId：对端路由器接口所属账号ID。
  • Status：路由器接口状态。
  • Name：路由器接口名称。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeRouterInterfaces

要执行的操作。

取值： DescribeRouterInterfaces 。

RegionId String 是 cn-hangzhou

路由器接口所在的地域。 您可以通过调用DescribeRegions接口获取地域ID。

IncludeReservationData Boolean 否 false

是否包含续费数据。
PageNumber Integer 否 1

列表的页码，默认值为1。

PageSize Integer 否 10

分页查询时每页的行数，最大值为50，默认值为10。

Filter.N.Key String 否 Filter.1.status

第n个过滤条件的类型。N的取值范围：1-5。

Filter.N.Value.N RepeatList 否 Filter.1.Active

第n个过滤器的第m个值。M的取值范围：1-5。

返回数据

名称 类型 示例值 描述
TotalCount Integer 2

列表条目数。
PageNumber Integer 1

当前页码。
PageSize Integer 10

每页包含多少条目。
RequestId String C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45

请求ID。
RouterInterfaceSet Array

路由器接口的详细信息。
RouterInterfaceType
AccessPointId String ap-cn-shanghaiSZ-****

接入点ID。
Bandwidth Integer 10

路由器接口的带宽。
BusinessStatus String Normal

路由器接口的业务状态：

  • Normal：正常
  • FinancialLocked：欠费锁定
  • SecurityLocked：安全风控锁定
ChargeType String PayByTraffic

付费方式。
ConnectedTime String 2017-06-08T12:20:55

连接建立的时间。
CreationTime String 2017-06-08T12:20:55

路由表的创建时间。
CrossBorder Boolean false

是否是跨境连接。
Description String 路由表接口描述。

路由表接口描述。
EndTime String 2017-06-08T12:20:55

获取数据的结束时间点。
HasReservationData String false

是否有续费数据。
HcRate Integer 1

健康检查速率。
HcThreshold Integer 2

健康检查阈值。
HealthCheckSourceIp String 116.62.222.XX

健康检查源IP。
HealthCheckTargetIp String 116.62.222.XX

健康检查目标IP。
Name String test

自定义名称。
OppositeAccessPointId String ap-cn-shanghaiSZ-****

对端接入点ID。
OppositeBandwidth Integer 12

对端带宽。
OppositeInterfaceBusinessStatus String Normal

连接对端的路由器接口的业务状态。
OppositeInterfaceId String ri-bp1itx13bwe6f2wfh****

对端路由器接口ID。
OppositeInterfaceOwnerId String 123157908552****

对端路由器接口的账号ID。
OppositeInterfaceSpec String Large

连接对端路由器接口的规格。
OppositeInterfaceStatus String Normal

连接对端的路由器接口的状态。
OppositeRegionId String cn-shanghai

连接对端所处的地域。
OppositeRouterId String vrt-bp1d3bxtdv68tfd7g****

连接对端的路由器接口所属的路由器ID。
OppositeRouterType String VRouter

连接对端的路由器接口所属的路由器类型。
OppositeVpcInstanceId String vpc-bp1qpo0kug3a20qqe****

对端的VPC ID。
ReservationActiveTime String 2019-03-11T16:00:00Z

续费生效时间。
ReservationBandwidth String 10

续费带宽。
ReservationInternetChargeType String PayByBandwidth

续费付费类型。
ReservationOrderType String RENEWCHANGE

续费订单类型。
Role String InitiatingSide

对等连接中的角色。
RouterId String vrt-bp1d3bxtdv68tfd7g****

路由条目所在路由器的ID。
RouterInterfaceId String ri-2zenfgfpyu3v93koa****

路由器接口的ID。
RouterType String VRouter

路由表所在路由器的类型，取值：

  • VRouter：VPC路由器
  • VBR：边界路由器
Spec String Large

路由器接口的规格。
Status String active

路由器接口的状态。
VpcInstanceId String vpc-2ze3tq4uxhysg717x****

对等连接中本端VPC的ID。

示例

请求示例

https://vpc.aliyuncs.com/?Action=DescribeRouterInterfaces
&RegionId= cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeRouterInterfacesResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>2</TotalCount>
	  <PageSize>10</PageSize>
	  <RequestId>01818199-04F6-47F4-9ADF-7CC824CF57A4</RequestId>
	  <RouterInterfaceSet>
		    <RouterInterfaceType>
			      <ChargeType>Prepaid</ChargeType>
			      <HasReservationData>false</HasReservationData>
			      <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
			      <RouterInterfaceId>ri-2zenfgfpyu3v93ko****</RouterInterfaceId>
			      <OppositeInterfaceStatus>Deleted</OppositeInterfaceStatus>
			      <Spec>Small.5</Spec>
			      <OppositeInterfaceOwnerId>123157908552****</OppositeInterfaceOwnerId>
			      <CrossBorder>false</CrossBorder>
			      <OppositeInterfaceSpec>Negative</OppositeInterfaceSpec>
			      <CreationTime>2017-12-27T06:34:30Z</CreationTime>
			      <RouterType>VRouter</RouterType>
			      <Status>Inactive</Status>
			      <OppositeRouterType>VRouter</OppositeRouterType>
			      <OppositeRouterId>vrt-bp1el837xkkakub7****</OppositeRouterId>
			      <OppositeInterfaceId>ri-bp1itx13bwe6f2wfh****</OppositeInterfaceId>
			      <VpcInstanceId>vpc-2ze3tq4uxhysg717x****</VpcInstanceId>
			      <RouterId>vrt-2zeazning6tbzkm5c****</RouterId>
			      <ConnectedTime>2017-12-27T06:34:37Z</ConnectedTime>
			      <OppositeRegionId>cn-hangzhou</OppositeRegionId>
			      <BusinessStatus>Normal</BusinessStatus>
			      <Role>InitiatingSide</Role>
			      <OppositeVpcInstanceId>vpc-bp1iq3579f26c3gp****</OppositeVpcInstanceId>
			      <EndTime>2018-01-27T16:00:00Z</EndTime>
		    </RouterInterfaceType>
		    <RouterInterfaceType>
			      <ChargeType>Prepaid</ChargeType>
			      <HasReservationData>false</HasReservationData>
			      <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
			      <RouterInterfaceId>ri-2zegbp7nhj0mnwm6i****</RouterInterfaceId>
			      <OppositeInterfaceStatus>Deleted</OppositeInterfaceStatus>
			      <Spec>Small.1</Spec>
			      <OppositeInterfaceOwnerId>123157908552****</OppositeInterfaceOwnerId>
			      <CrossBorder>false</CrossBorder>
			      <OppositeInterfaceSpec>Negative</OppositeInterfaceSpec>
			      <CreationTime>2017-12-27T06:31:30Z</CreationTime>
			      <RouterType>VRouter</RouterType>
			      <Status>Inactive</Status>
			      <OppositeRouterType>VRouter</OppositeRouterType>
			      <OppositeRouterId>vrt-bp1d3bxtdv68tfd7g****</OppositeRouterId>
			      <OppositeInterfaceId>ri-bp12dxgw8gmoma1h****</OppositeInterfaceId>
			      <VpcInstanceId>vpc-2ze3tq4uxhysg717x****</VpcInstanceId>
			      <RouterId>vrt-2zeazning6tbzkm5c****</RouterId>
			      <ConnectedTime>2017-12-27T06:31:36Z</ConnectedTime>
			      <OppositeRegionId>cn-hangzhou</OppositeRegionId>
			      <BusinessStatus>Normal</BusinessStatus>
			      <Role>InitiatingSide</Role>
			      <OppositeVpcInstanceId>vpc-bp15k6sx6fhdz2jw****</OppositeVpcInstanceId>
			      <EndTime>2018-10-27T16:00:00Z</EndTime>
		    </RouterInterfaceType>
	  </RouterInterfaceSet>
</DescribeRouterInterfacesResponse>

JSON 格式 

{
    "PageNumber": 1,
    "TotalCount": 2,
    "PageSize": 10,
    "RequestId": "01818199-04F6-47F4-9ADF-7CC824CF57A4",
    "RouterInterfaceSet": {
        "RouterInterfaceType": [
            {
                "ChargeType": "Prepaid",
                "HasReservationData": false,
                "OppositeInterfaceBusinessStatus": "Normal",
                "RouterInterfaceId": "ri-2zenfgfpyu3v93k****",
                "OppositeInterfaceStatus": "Deleted",
                "Spec": "Small.5",
                "OppositeInterfaceOwnerId": "12315790855****",
                "CrossBorder": false,
                "OppositeInterfaceSpec": "Negative",
                "CreationTime": "2017-12-27T06:34:30Z",
                "RouterType": "VRouter",
                "Status": "Inactive",
                "OppositeRouterType": "VRouter",
                "OppositeRouterId": "vrt-bp1el837xkkakub7****",
                "OppositeInterfaceId": "ri-bp1itx13bwe6f2wf****",
                "VpcInstanceId": "vpc-2ze3tq4uxhysg717x****",
                "RouterId": "vrt-2zeazning6tbzkm5c****",
                "ConnectedTime": "2017-12-27T06:34:37Z",
                "OppositeRegionId": "cn-hangzhou",
                "BusinessStatus": "Normal",
                "Role": "InitiatingSide",
                "OppositeVpcInstanceId": "vpc-bp1iq3579f26c3gpk****",
                "EndTime": "2018-01-27T16:00:00Z"
            },
            {
                "ChargeType": "Prepaid",
                "HasReservationData": false,
                "OppositeInterfaceBusinessStatus": "Normal",
                "RouterInterfaceId": "ri-2zegbp7nhj0mnwm6i****",
                "OppositeInterfaceStatus": "Deleted",
                "Spec": "Small.1",
                "OppositeInterfaceOwnerId": "123157908552****",
                "CrossBorder": false,
                "OppositeInterfaceSpec": "Negative",
                "CreationTime": "2017-12-27T06:31:30Z",
                "RouterType": "VRouter",
                "Status": "Inactive",
                "OppositeRouterType": "VRouter",
                "OppositeRouterId": "vrt-bp1d3bxtdv68tfd7****",
                "OppositeInterfaceId": "ri-bp12dxgw8gmoma1h****",
                "VpcInstanceId": "vpc-2ze3tq4uxhysg717****",
                "RouterId": "vrt-2zeazning6tbzkm5c****",
                "ConnectedTime": "2017-12-27T06:31:36Z",
                "OppositeRegionId": "cn-hangzhou",
                "BusinessStatus": "Normal",
                "Role": "InitiatingSide",
                "OppositeVpcInstanceId": "vpc-bp15k6sx6fhdz2jw4****",
                "EndTime": "2018-10-27T16:00:00Z"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key 该过滤器的Key不支持：Filter.X.key
400 InvalidParam.NotNull The parameter must not be null. 参数不能为空。

访问错误中心查看更多错误码。