调用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 String 否 test

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

返回数据

名称 类型 示例值 描述
RequestId String C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45

请求ID。
PageNumber Integer 1

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

PageSize Integer 10

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

TotalCount Integer 1

列表条目数。
RouterInterfaceSet Array of RouterInterfaceType

路由器接口的详细信息。
RouterInterfaceType
ReservationActiveTime String 2021-03-11T16:00:00Z

续费生效时间。

时间按照ISO8601标准表示，并使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。

HealthCheckTargetIp String 116.62.XX.XX

健康检查目标IP。
Status String active

路由器接口的状态。
CreationTime String 2021-06-08T12:20:55

路由表的创建时间。

时间按照ISO8601标准表示，并使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。

ReservationOrderType String RENEWCHANGE

续费订单类型。
OppositeInterfaceId String ri-bp1itx13bwe6f2wfh****

对端路由器接口ID。
Spec String Large

路由器接口的规格。
ChargeType String PayByTraffic

付费方式。
RouterInterfaceId String ri-2zenfgfpyu3v93koa****

路由器接口ID。
HcThreshold Integer 2

健康检查阈值。
OppositeRouterType String VRouter

连接对端的路由器接口所属的路由器类型。
VpcInstanceId String vpc-2ze3tq4uxhysg717x****

对等连接中本端VPC的ID。
OppositeInterfaceOwnerId String 271598332402530847

对端路由器接口所属的账号ID。
OppositeVpcInstanceId String vpc-bp1qpo0kug3a20qqe****

对端VPC的ID。
ReservationInternetChargeType String PayByBandwidth

续费付费类型。
CrossBorder Boolean false

是否是跨境连接。
Bandwidth Integer 10

路由器接口的带宽。单位：Mbps。
Description String 路由表接口描述

路由表接口描述。
HcRate Integer 1

健康检查速率。
ReservationBandwidth String 10

续费带宽。单位：Mbps。
Name String test

自定义名称。
OppositeRouterId String vrt-bp1d3bxtdv68tfd7g****

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

连接对端路由器接口的规格。
RouterId String vrt-bp1d3bxtdv68tfd7g****

路由条目所在路由器的ID。
OppositeInterfaceBusinessStatus String Normal

连接对端的路由器接口的业务状态。
ConnectedTime String 2021-06-08T12:20:55

连接建立的时间。

时间按照ISO8601标准表示，并使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。

HealthCheckSourceIp String 116.62.XX.XX

健康检查源IP。
OppositeInterfaceStatus String Normal

连接对端的路由器接口的状态。
EndTime String 2021-06-08T12:20:55

获取数据的结束时间点。

时间按照ISO8601标准表示，并使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。

OppositeRegionId String cn-shanghai

连接对端所在的地域ID。
OppositeAccessPointId String ap-cn-shanghaiSZ-****

对端接入点ID。
BusinessStatus String Normal

路由器接口的业务状态。取值：

  • Normal：正常。
  • FinancialLocked：欠费锁定。
  • SecurityLocked：安全风控锁定。
OppositeBandwidth Integer 12

对端带宽。单位：Mbps。
RouterType String VRouter

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

  • VRouter：VPC路由器。
  • VBR：边界路由器。
Role String InitiatingSide

对等连接中的角色。
HasReservationData String false

是否有续费数据。
AccessPointId String ap-cn-shanghaiSZ-****

接入点ID。
Ipv6Status String on

是否开启IPv6安全防护。取值：

  • on：开启。
  • off：关闭。
  • unsupport：不支持。
FastLinkMode Boolean false

是否为使用快速连接模式创建的VBR上联路由器接口，快速连接模式可实现VBR和VPC两端路由器接口创建完毕后自动完成连接。取值：

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeRouterInterfaces
&RegionId= cn-hangzhou
&IncludeReservationData=false
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"Filter.1.Status","Value":["test"]}]
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "RouterInterfaceSet" : [ {
    "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
  } ]
}

错误码

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。

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