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

调试

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

请求参数

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

要执行的操作。

取值：DescribeRouterInterfaces。

RegionId String 是 cn-hangzhou

路由器接口所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

IncludeReservationData Boolean 否 false

是否包含续费数据。

  • true：是。
  • false（默认值）：否。
PageNumber Integer 否 1

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

PageSize Integer 否 10

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

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

过滤条件，最多可提供5个过滤条件。支持以下过滤条件：

  • RouterInterfaceId：路由器接口ID。
  • RouterId：路由器ID。
  • RouterType：路由器类型，取值为VRouter或VBR。
  • RouterInterfaceOwnerId：路由器接口的所属账号ID。
  • OppositeInterfaceId：对端路由器接口ID。
  • OppositeRouterType：对端路由器接口类型，取值为VRouter或VBR。
  • OppositeRouterId：对端路由器接口ID。
  • OppositeInterfaceOwnerId：对端路由器接口所属账号ID。
  • Status：路由器接口状态。
  • Name：路由器接口名称。
说明 每个过滤条件的多个值之间为或关系，即只要与其中一个值吻合则视为符合该过滤条件。各个过滤条件之间为与关系，即符合所有指定的过滤条件，才会进入最终的查询结果。
Filter.N.Value.N RepeatList 否 Filter.1.Active 1

根据Key指定过滤值。一个Key支持指定多个过滤值，每个过滤值之间是或的关系，即只要符合其中一个过滤值，则视为匹配该过滤条件。

返回数据

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

列表条目数。
PageNumber Integer 1

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

PageSize Integer 10

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

RequestId String C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45

请求ID。
RouterInterfaceSet Array of RouterInterfaceType

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

接入点ID。
Bandwidth Integer 10

路由器接口的带宽。单位：Mbps。
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.XX.XX

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

健康检查目标IP。
Name String test

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

对端接入点ID。
OppositeBandwidth Integer 12

对端带宽。单位：Mbps。
OppositeInterfaceBusinessStatus String Normal

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

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

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

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

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

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

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

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

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

续费生效时间。
ReservationBandwidth String 10

续费带宽。单位：Mbps。
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。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeRouterInterfaces
&RegionId= cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<DescribeRouterInterfacesResponse>
      <TotalCount>2</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45</RequestId>
      <PageNumber>1</PageNumber>
      <RouterInterfaceSet>
            <RouterInterfaceType>
                  <OppositeInterfaceStatus>Normal</OppositeInterfaceStatus>
                  <OppositeInterfaceId>ri-bp1itx13bwe6f2wfh****</OppositeInterfaceId>
                  <OppositeRouterId>vrt-bp1d3bxtdv68tfd7g****</OppositeRouterId>
                  <Description>路由表接口描述</Description>
                  <EndTime>2017-06-08T12:20:55</EndTime>
                  <RouterId>vrt-bp1d3bxtdv68tfd7g****</RouterId>
                  <BusinessStatus>Normal</BusinessStatus>
                  <Name>test</Name>
                  <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
                  <OppositeRouterType>VRouter</OppositeRouterType>
                  <OppositeBandwidth>12</OppositeBandwidth>
                  <Bandwidth>10</Bandwidth>
                  <ConnectedTime>2017-06-08T12:20:55</ConnectedTime>
                  <ReservationActiveTime>2019-03-11T16:00:00Z</ReservationActiveTime>
                  <ReservationBandwidth>10</ReservationBandwidth>
                  <HcThreshold>2</HcThreshold>
                  <Status>active</Status>
                  <OppositeInterfaceOwnerId>123157908552****</OppositeInterfaceOwnerId>
                  <OppositeRegionId>cn-shanghai</OppositeRegionId>
                  <HealthCheckSourceIp>116.62.XX.XX</HealthCheckSourceIp>
                  <HasReservationData>false</HasReservationData>
                  <CrossBorder>false</CrossBorder>
                  <HcRate>1</HcRate>
                  <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
                  <Role>InitiatingSide</Role>
                  <OppositeInterfaceSpec>Large</OppositeInterfaceSpec>
                  <OppositeVpcInstanceId>vpc-bp1qpo0kug3a20qqe****</OppositeVpcInstanceId>
                  <RouterType>VRouter</RouterType>
                  <ChargeType>PayByTraffic</ChargeType>
                  <AccessPointId>ap-cn-shanghaiSZ-****</AccessPointId>
                  <CreationTime>2017-06-08T12:20:55</CreationTime>
                  <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
                  <VpcInstanceId>vpc-2ze3tq4uxhysg717x****</VpcInstanceId>
                  <OppositeAccessPointId>ap-cn-shanghaiSZ-****</OppositeAccessPointId>
                  <Spec>Large</Spec>
                  <RouterInterfaceId>ri-2zenfgfpyu3v93koa****</RouterInterfaceId>
                  <HealthCheckTargetIp>116.62.XX.XX</HealthCheckTargetIp>
            </RouterInterfaceType>
      </RouterInterfaceSet>
</DescribeRouterInterfacesResponse>

JSON格式 

{
    "TotalCount": 2,
    "PageSize": 10,
    "RequestId": "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
    "PageNumber": 1,
    "RouterInterfaceSet": {
        "RouterInterfaceType": {
            "OppositeInterfaceStatus": "Normal",
            "OppositeInterfaceId": "ri-bp1itx13bwe6f2wfh****",
            "OppositeRouterId": "vrt-bp1d3bxtdv68tfd7g****",
            "Description": "路由表接口描述",
            "EndTime": "2017-06-08T12:20:55",
            "RouterId": "vrt-bp1d3bxtdv68tfd7g****",
            "BusinessStatus": "Normal",
            "Name": "test",
            "ReservationOrderType": "RENEWCHANGE",
            "OppositeRouterType": "VRouter",
            "OppositeBandwidth": 12,
            "Bandwidth": 10,
            "ConnectedTime": "2017-06-08T12:20:55",
            "ReservationActiveTime": "2019-03-11T16:00:00Z",
            "ReservationBandwidth": 10,
            "HcThreshold": 2,
            "Status": "active",
            "OppositeInterfaceOwnerId": "123157908552****",
            "OppositeRegionId": "cn-shanghai",
            "HealthCheckSourceIp": "116.62.XX.XX",
            "HasReservationData": false,
            "CrossBorder": false,
            "HcRate": 1,
            "ReservationInternetChargeType": "PayByBandwidth",
            "Role": "InitiatingSide",
            "OppositeInterfaceSpec": "Large",
            "OppositeVpcInstanceId": "vpc-bp1qpo0kug3a20qqe****",
            "RouterType": "VRouter",
            "ChargeType": "PayByTraffic",
            "AccessPointId": "ap-cn-shanghaiSZ-****",
            "CreationTime": "2017-06-08T12:20:55",
            "OppositeInterfaceBusinessStatus": "Normal",
            "VpcInstanceId": "vpc-2ze3tq4uxhysg717x****",
            "OppositeAccessPointId": "ap-cn-shanghaiSZ-****",
            "Spec": "Large",
            "RouterInterfaceId": "ri-2zenfgfpyu3v93koa****",
            "HealthCheckTargetIp": "116.62.XX.XX"
        }
    }
}

错误码

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

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