调用DescribeVirtualBorderRouters接口查询已创建的边界路由器(VBR)。

调试

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

请求参数

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

要执行的操作。

取值:DescribeVirtualBorderRouters

RegionId String cn-shanghai

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

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

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

Filter.N.Key String 1

第N个过滤条件的key,N取值:1-5

支持过滤参数为:

  • PhysicalConnectionId:物理专线实例ID。
  • VbrId:边界路由器实例ID。
  • Status:边界路由器状态。
  • Name:边界路由器名称。
  • AccessPointId:接入点ID。
  • eccId:高速上云服务实例ID。
  • type:物理专线类型。
Filter.N.Value.N RepeatList 1

第N个过滤条件对应的取值,N取值:1-5

返回数据

名称 类型 示例值 描述
RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

请求ID。

PageNumber Integer 1

当前页码。

PageSize Integer 10

每页包含多少条目。

TotalCount Integer 1

列表条条目数。

VirtualBorderRouterSet Array

查询到的VBR合集。

VbrId String vbr-kojok19xx******

VBR的ID。

CreationTime String 2017-06-08T12:20:55

VBR的创建时间。

ActivationTime String 2017-06-08T12:20:55

VBR第一次激活的时间。

TerminationTime String 2017-06-08T12:20:55

VBR最近一次被终止的时间。

RecoveryTime String 2017-06-08T12:20:55

VBR最近一次从Terminated状态恢复到Active状态的时间。

Status String active

物理专线状态:

  • Initial:申请中
  • Approved:审批通过
  • Allocating:正在分配资源
  • Allocated:接入施工中。
  • Confirmed:等待用户确认
  • Enabled:已开通
  • Rejected:申请被拒绝
  • Canceled:已取消
  • Allocation Failed:资源分配失败
  • Terminated:已终止
VlanId Integer 10

VBR的VLAN ID。

CircuitCode String longtel001

运营商为物理专线提供的电路编码。

RouteTableId String rtb-bp1nxxxxxxxx*******

VBR的路由表的ID。

VlanInterfaceId String ri-2zeo3xzyf38r4xx*******

VBR的路由器接口的ID。

LocalGatewayIp String 116.62.**.**

阿里云侧互联IP。

PeerGatewayIp String 116.62.**.**

客户侧互联IP。

PeeringSubnetMask String 255.255.255.252

阿里云侧互联IP和客户侧互联IP的子网掩码。

PhysicalConnectionId String pc-119mfjzm7x******

VBR所属的物理专线的ID。

PhysicalConnectionStatus String Normal

物理专线状态。

PhysicalConnectionBusinessStatus String Normal

物理专线业务状态。

PhysicalConnectionOwnerUid String usdgbh123f******

物理专线所有者的UID。

AccessPointId String ap-cn-kojok1xxxxxxxx

物理专线接入点的ID。

Name String test

VBR的名称。

Description String VBR

VBR的描述信息。

PConnVbrExpireTime String 2017-06-08T12:20:55

计费VBR的超期时间。

EccId String ecc-h*********

高速上云服务实例ID。

Type String ecc

物理专线类型。

MinTxInterval Long 100

配置BFD报文的发送间隔,取值:200-1000,单位为ms。

MinRxInterval Long 100

配置BFD报文的接收间隔,取值:200-1000,单位为ms。

DetectMultiplier Long 3

检测时间倍数。

即接收方允许发送方发送报文的最大连接丢包数,用来检测链路是否正常。

取值:3~10

AssociatedPhysicalConnections Array

绑定的物理连接。

CircuitCode String 12

VBR专线侧接口对应运营商的电路编码。

VlanInterfaceId String ri-kojok19x3j0q6kxxxxxxxxx

虚拟边界路由器(VBR)专线侧接口(RouterInterface)的ID。可以用来做VBR上路由的下一跳。

LocalGatewayIp String 116.62.xx.xx

VBR专线侧接口本端的IP地址。

PeerGatewayIp String 116.62.xx.xx

VBR专线侧接口对端的IP地址。

PeeringSubnetMask String 255.255.255.252

实VBR专线侧接口本端与对端互联的子网掩码。

PhysicalConnectionId String pc-119mfjzm7xxxxxxxx

物理专线ID。

PhysicalConnectionStatus String Normal

物理专线状态。

PhysicalConnectionBusinessStatus String Normal

物理专线业务状态。

PhysicalConnectionOwnerUid String qfrgrgs

物理专线owner的UID。

VlanId String 0

VBR的VLAN ID。

AssociatedCens Array

云企业网。

CenId String cen-kojok19xxxxxxxx

云企业网实例的ID。

CenOwnerId Long 1086496381294461

云企业网实例所属账号的UID。

CenStatus String Attached

云企业网状态。

示例

请求示例

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

正常返回示例

XML 格式

<DescribeVirtualBorderRoutersResponse>
		  <RequestId>AE65530E-8436-4FB1-8217-DCD35712AC89</RequestId>
		  <PageNumber>1</PageNumber>
		  <VirtualBorderRouterSet>
			    <VirtualBorderRouterType>
				      <LocalGatewayIp>10.1.xx.xx</LocalGatewayIp>
				      <PeerGatewayIp>10.2.xx.xx</PeerGatewayIp>
				      <PhysicalConnectionOwnerUid>123157908XXXXXXXX</PhysicalConnectionOwnerUid>
				      <VlanId>10</VlanId>
				      <PhysicalConnectionStatus>Enabled</PhysicalConnectionStatus>
				      <PhysicalConnectionId>pc-2zeoaxkq3jotxxxxxxxx</PhysicalConnectionId>
				      <RouteTableId>vtb-2ze9hmd6yofwvxxxxxxxx</RouteTableId>
				      <PeeringSubnetMask>255.0.0.0</PeeringSubnetMask>
				      <CreationTime>2018-03-06T11:16:34Z</CreationTime>
				      <ActivationTime>2018-03-06T11:16:34Z</ActivationTime>
				      <Status>active</Status>
				      <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
				      <VlanInterfaceId>ri-2zeum6rgu0586xxxxxxxx</VlanInterfaceId>
				      <AccessPointId>ap-cn-beijing-dx-A</AccessPointId>
				      <VbrId>vbr-2zecmmvg5gxxxxxxxx</VbrId>
			    </VirtualBorderRouterType>
		  </VirtualBorderRouterSet>
		  <TotalCount>1</TotalCount>
		  <PageSize>10</PageSize>
</DescribeVirtualBorderRoutersResponse>

JSON 格式

{
    "DescribeVirtualBorderRoutersResponse": {
        "RequestId": "AE65530E-8436-4FB1-8217-DCD35712AC89",
        "PageNumber": "1",
        "VirtualBorderRouterSet": {
            "VirtualBorderRouterType": {
                "LocalGatewayIp": "10.1.xx.xx",
                "PeerGatewayIp": "10.2.xx.xx",
                "PhysicalConnectionOwnerUid": "123157908XXXXXXXX",
                "VlanId": "10",
                "PhysicalConnectionStatus": "Enabled",
                "PhysicalConnectionId": "pc-2zeoaxkq3jotxxxxxxxx",
                "RouteTableId": "vtb-2ze9hmd6yofwvxxxxxxxx",
                "PeeringSubnetMask": "255.0.0.0",
                "CreationTime": "2018-03-06T11:16:34Z",
                "ActivationTime": "2018-03-06T11:16:34Z",
                "Status": "active",
                "PhysicalConnectionBusinessStatus": "Normal",
                "VlanInterfaceId": "ri-2zeum6rgu0586xxxxxxxx",
                "AccessPointId": "ap-cn-beijing-dx-A",
                "VbrId": "vbr-2zecmmvg5gxxxxxxxx"
            }
        },
        "TotalCount": "1",
        "PageSize": "10"
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key 该过滤器的Key不支持:Filter.X.key

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