调用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个过滤条件。N的取值范围:1~20。支持以下过滤条件:

  • RouterInterfaceId:路由器接口ID。
  • RouterId:路由器ID。
  • RouterType:路由器类型,取值为VRouterVBR
  • RouterInterfaceOwnerId:路由器接口的所属账号ID。
  • OppositeInterfaceId:对端路由器接口ID。
  • OppositeRouterType:对端路由器接口类型,取值为VRouterVBR
  • OppositeRouterId:对端路由器接口ID。
  • OppositeInterfaceOwnerId:对端路由器接口所属账号ID。
  • Status:路由器接口状态。
  • Name:路由器接口名称。
说明 每个过滤条件的多个值之间为或关系,即只要与其中一个值吻合则视为符合该过滤条件。各个过滤条件之间为与关系,即同时符合所有指定的过滤条件,才会显示在最终的查询结果。

返回数据

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

请求ID。

PageNumber Integer 1

列表的页码,默认值:1

PageSize Integer 10

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

TotalCount Integer 2

列表条目数。

RouterInterfaceSet Array of RouterInterfaceType

路由器接口的详细信息。

RouterInterfaceType
ReservationActiveTime String 2019-03-11T16:00:00Z

续费生效时间。

HealthCheckTargetIp String 116.62.XX.XX

健康检查目标IP。

说明 当指定了HealthCheckSourceIp后,该参数为必选。
Status String active

路由器接口的状态:

  • Normal:正常。
  • FinancialLocked:欠费锁定。
  • SecurityLocked:安全风控锁定。
CreationTime String 2018-05-28T08:15:00Z

路由器接口创建的时间。

ReservationOrderType String RENEWCHANGE

续费订单类型。

OppositeInterfaceId String ri-2zeo3xzyf38r4urzd****

对端路由器接口ID。

Spec String Mini.2

路由器接口的规格。可用的规格和对应的带宽如下:

  • Mini.2:2 Mbps
  • Mini.5:5 Mbps
    • Small.1:10 Mbps
    • Small.2:20 Mbps
  • Small.5:50 Mbps
    • Middle.1:100 Mbps
    • Middle.2:200 Mbps
    • Middle.5:500 Mbps
    • Large.1:1000 Mbps
    • Large.2:2000 Mbps
    • Large.5:5000 Mbps
    • Xlarge.1:10000 Mbps
      说明RoleAcceptingSide(连接接收端)时,Spec取值为Negative
ChargeType String PayByTraffic

付费方式。

RouterInterfaceId String ri-2zeo3xzyf38r4urz****

路由器接口ID。

HcThreshold Integer 12

健康检查阈值。

OppositeRouterType String VRouter

对端路由器接口关联的路由器类型,取值:

  • VRouter:VPC路由器。
  • VBR:边界路由器。
VpcInstanceId String vpc-2ze3tq4uxhysg717x****

对等连接中本端VPC的ID。

OppositeInterfaceOwnerId String 123157908552xxx

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

OppositeVpcInstanceId String vpc-bp1qpo0kug3a20qqe****

对端VPC的ID。

ReservationInternetChargeType String PayByBandwidth

续费付费类型。

CrossBorder Boolean false

是否是跨境连接:

  • false:不是。
  • true:是。
Bandwidth Integer 10

路由器接口的带宽。单位:Mbps。

Description String abcabc

路由表接口描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http://https://开头。

HcRate Integer 2

健康检查速率。

ReservationBandwidth String 10

续费带宽。单位:Mbps。

Name String abc

路由器接口的名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。但不能以http://https://开头。

OppositeRouterId String vrt-bp1lhl0taikrteen8****vrt-bp1d3bxtdv68tfd7g****

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

OppositeInterfaceSpec String Large

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

RouterId String vrt-bp1d3bxtdv68tfd7xxxx

路由条目所在路由器的ID。

OppositeInterfaceBusinessStatus String Normal

连接对端的路由器接口的业务状态:

  • Normal:正常。
  • FinancialLocked:欠费锁定。
  • SecurityLocked:安全风控锁定。
ConnectedTime String 2017-06-08T12:20:55

连接建立的时间。

HealthCheckSourceIp String 116.62.XX.XX

健康检查源IP地址,必须是本端VPC内的一个未被使用的IP。

说明 物理专线接入场景下可指定该参数。
OppositeInterfaceStatus String Normal

连接对端的路由器接口的状态:

  • Normal:正常。
  • FinancialLocked:欠费锁定。
  • SecurityLocked:安全风控锁定。
EndTime String 2999-09-08T16:00:00Z

获取数据的结束时间点。

OppositeRegionId String cn-shanghai

连接对端路由器接口的地域。

OppositeAccessPointId String ap-cn-shanghaiSZ-****

对端接入点ID。

说明 对端路由器接口位于VBR上时需指定该参数,创建路由器接口后无法修改。
BusinessStatus String Normal

路由器接口的业务状态。

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

对端带宽。单位:Mbps。

RouterType String VRouter

路由表所在路由器的类型。

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

路由器接口的角色,取值:

  • InitiatingSide:连接发起端。
  • AcceptingSide:连接接收端。
HasReservationData String false

是否有续费数据。

  • false:没有。
  • true:有。
AccessPointId String ap-cn-shanghaiSZ-****

物理专线接入点ID。您可以通过调用DescribeAccessPoints接口获取物理专线接入点ID。

Ipv6Status String on

是否开启IPv6安全防护,取值:

  • on:开启。
  • off:关闭。
  • unsupport:不支持。

示例

请求示例

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

正常返回示例

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>2</TotalCount>
    <RouterInterfaceSet>
        <ReservationActiveTime>2019-03-11T16:00:00Z</ReservationActiveTime>
        <HealthCheckTargetIp>116.62.XX.XX</HealthCheckTargetIp>
        <Status>active</Status>
        <CreationTime>2018-05-28T08:15:00Z</CreationTime>
        <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
        <OppositeInterfaceId>ri-2zeo3xzyf38r4urzd****</OppositeInterfaceId>
        <Spec>Mini.2</Spec>
        <ChargeType>PayByTraffic</ChargeType>
        <RouterInterfaceId>ri-2zeo3xzyf38r4urz****</RouterInterfaceId>
        <HcThreshold>12</HcThreshold>
        <OppositeRouterType>VRouter</OppositeRouterType>
        <VpcInstanceId>vpc-2ze3tq4uxhysg717x****</VpcInstanceId>
        <OppositeInterfaceOwnerId>123157908552xxx</OppositeInterfaceOwnerId>
        <OppositeVpcInstanceId>vpc-bp1qpo0kug3a20qqe****</OppositeVpcInstanceId>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <CrossBorder>false</CrossBorder>
        <Bandwidth>10</Bandwidth>
        <Description>abcabc</Description>
        <HcRate>2</HcRate>
        <ReservationBandwidth>10</ReservationBandwidth>
        <Name>abc</Name>
        <OppositeRouterId>vrt-bp1lhl0taikrteen8****vrt-bp1d3bxtdv68tfd7g****</OppositeRouterId>
        <OppositeInterfaceSpec>Large</OppositeInterfaceSpec>
        <RouterId>vrt-bp1d3bxtdv68tfd7xxxx</RouterId>
        <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
        <ConnectedTime>2017-06-08T12:20:55</ConnectedTime>
        <HealthCheckSourceIp>116.62.XX.XX</HealthCheckSourceIp>
        <OppositeInterfaceStatus>Normal</OppositeInterfaceStatus>
        <EndTime>2999-09-08T16:00:00Z</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>
    </RouterInterfaceSet>
</DescribeRouterInterfacesResponse>

JSON格式

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

{
  "RequestId" : "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 2,
  "RouterInterfaceSet" : [ {
    "ReservationActiveTime" : "2019-03-11T16:00:00Z",
    "HealthCheckTargetIp" : "116.62.XX.XX",
    "Status" : "active",
    "CreationTime" : "2018-05-28T08:15:00Z",
    "ReservationOrderType" : "RENEWCHANGE",
    "OppositeInterfaceId" : "ri-2zeo3xzyf38r4urzd****",
    "Spec" : "Mini.2",
    "ChargeType" : "PayByTraffic",
    "RouterInterfaceId" : "ri-2zeo3xzyf38r4urz****",
    "HcThreshold" : 12,
    "OppositeRouterType" : "VRouter",
    "VpcInstanceId" : "vpc-2ze3tq4uxhysg717x****",
    "OppositeInterfaceOwnerId" : "123157908552xxx",
    "OppositeVpcInstanceId" : "vpc-bp1qpo0kug3a20qqe****",
    "ReservationInternetChargeType" : "PayByBandwidth",
    "CrossBorder" : false,
    "Bandwidth" : 10,
    "Description" : "abcabc",
    "HcRate" : 2,
    "ReservationBandwidth" : "10",
    "Name" : "abc",
    "OppositeRouterId" : "vrt-bp1lhl0taikrteen8****vrt-bp1d3bxtdv68tfd7g****",
    "OppositeInterfaceSpec" : "Large",
    "RouterId" : "vrt-bp1d3bxtdv68tfd7xxxx",
    "OppositeInterfaceBusinessStatus" : "Normal",
    "ConnectedTime" : "2017-06-08T12:20:55",
    "HealthCheckSourceIp" : "116.62.XX.XX",
    "OppositeInterfaceStatus" : "Normal",
    "EndTime" : "2999-09-08T16:00:00Z",
    "OppositeRegionId" : "cn-shanghai",
    "OppositeAccessPointId" : "ap-cn-shanghaiSZ-****",
    "BusinessStatus" : "Normal",
    "OppositeBandwidth" : 12,
    "RouterType" : "VRouter",
    "Role" : "InitiatingSide",
    "HasReservationData" : "false",
    "AccessPointId" : "ap-cn-shanghaiSZ-****",
    "Ipv6Status" : "on"
  } ]
}

错误码

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。

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