全部产品
Search
文档中心

专有网络 VPC:DescribeRouterInterfaces - 查询指定地域内的路由器接口

更新时间:Jun 20, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeRouterInterfacesList
  • RouterInterface
    acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-hangzhou
IncludeReservationDataboolean

是否包含续费数据。取值:

  • true:是。

  • false(默认值):否。

false
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

10
Filterobject []

过滤信息。

Keystring

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

  • RouterInterfaceId:路由器接口 ID。

  • RouterId:路由器 ID。

  • RouterType:路由器类型,取值为 VRouterVBR

  • RouterInterfaceOwnerId:路由器接口的所属账号 ID。

  • OppositeInterfaceId:对端路由器接口 ID。

  • OppositeRouterType:对端路由器接口类型,取值为 VRouterVBR

  • OppositeRouterId:对端路由器接口 ID。

  • OppositeInterfaceOwnerId:对端路由器接口所属账号 ID。

  • Status:路由器接口状态。

  • Name:路由器接口名称。

说明 每个过滤条件的多个值之间为或关系,即只要与其中一个值吻合则视为符合该过滤条件。各个过滤条件之间为与关系,即符合所有指定的过滤条件,才会进入最终的查询结果。
Filter.1.Status
Valuearray

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

string

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

test
ResourceGroupIdstring

资源组 ID。

关于资源组的更多信息,请参见什么是资源组

rg-acfmxazb4ph6aiy****
Tagsobject []

资源的标签。

Keystring

资源的标签键。至少输入 1 个标签键,最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

请求 ID。

C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

10
TotalCountinteger

列表条目数。

1
RouterInterfaceSetobject []

路由器接口的详细信息。

ReservationActiveTimestring

续费生效时间。

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

2021-03-11T16:00:00Z
HealthCheckTargetIpstring

健康检查目标 IP。

116.62.XX.XX
Statusstring

路由器接口的状态。

active
CreationTimestring

路由表的创建时间。

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

2021-06-08T12:20:55
ReservationOrderTypestring

续费订单类型。

RENEWCHANGE
OppositeInterfaceIdstring

对端路由器接口 ID。

ri-bp1itx13bwe6f2wfh****
Specstring

路由器接口的规格。

Large
ChargeTypestring

付费方式。

PayByTraffic
RouterInterfaceIdstring

路由器接口 ID。

ri-2zenfgfpyu3v93koa****
HcThresholdinteger

健康检查阈值。

2
OppositeRouterTypestring

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

VRouter
VpcInstanceIdstring

对等连接中本端 VPC 的 ID。

vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerIdstring

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

271598332402530847
OppositeVpcInstanceIdstring

对端 VPC 的 ID。

vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeTypestring

续费付费类型。

PayByBandwidth
CrossBorderboolean

是否是跨境连接。

false
Bandwidthinteger

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

10
Descriptionstring

路由表接口描述。

路由表接口描述
HcRateinteger

健康检查速率。

1
ReservationBandwidthstring

续费带宽。单位:Mbps。

10
Namestring

自定义名称。

test
OppositeRouterIdstring

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

vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpecstring

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

Large
RouterIdstring

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

vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatusstring

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

Normal
ConnectedTimestring

连接建立的时间。

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

2021-06-08T12:20:55
HealthCheckSourceIpstring

健康检查源 IP。

116.62.XX.XX
OppositeInterfaceStatusstring

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

Normal
EndTimestring

获取数据的结束时间点。

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

2021-06-08T12:20:55
OppositeRegionIdstring

连接对端所在的地域 ID。

cn-shanghai
OppositeAccessPointIdstring

对端接入点 ID。

ap-cn-shanghaiSZ-****
BusinessStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定。

  • SecurityLocked:安全风控锁定。

Normal
OppositeBandwidthinteger

对端带宽。单位:Mbps。

12
RouterTypestring

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

  • VRouter:VPC 路由器。

  • VBR:边界路由器。

VRouter
Rolestring

对等连接中的角色。

InitiatingSide
HasReservationDatastring

是否有续费数据。

false
AccessPointIdstring

接入点 ID。

ap-cn-shanghaiSZ-****
Ipv6Statusstring

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

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

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

  • true:是。

  • false(默认值):否。

false
ResourceGroupIdstring

资源组 ID。

关于资源组的更多信息,请参见什么是资源组

rg-acfmxazb4ph6aiy****
Tagsobject []

资源的标签。

Keystring

资源的标签键。

FinanceDept
Valuestring

资源的标签值。

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错误码错误信息描述
400InvalidParam.NotNullThe parameter must not be null.参数不能为空。
400EndPoint.Emptythe rc endpoint is empty.-
400InvalidConnectionType.MalFormedConnection type must be vpc2vpc or vbr2vpc.-
400InvalidProductForm.MalFormedProduct form must be routerinterface or expressconnect.-
400InvalidRole.Malformedrole must be InitiatingSide or AcceptingSide.-
400IllegalParam.AliUidSpecified value of aliuid invalid.-
400Parameter.IllegalThe parameter is illegal.参数非法
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
404InvalidFilterKey.ValueNotSupportedSpecified filter key is not supported: Filter.X.key该过滤器的Key不支持:Filter.X.key。
404InvalidRegionId.NotFoundThe parameter wrong, pageNum or pageSize.参数错误
404InvalidRegionId.NotFoundThe specified region does not exist.-

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

变更历史

变更时间变更内容概要操作
2023-09-11OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2023-07-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
    新增入参:Tags
出参OpenAPI 返回结构发生变更
2021-09-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-09-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更