调用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

返回数据

名称 类型 示例值 描述
VirtualBorderRouterSet Array of VirtualBorderRouterType

查询到的VBR合集。

VirtualBorderRouterType
AccessPointId String ap-cn-kojok1x*********

物理专线接入点的ID。

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

VBR第一次激活的时间。

AssociatedCens Array of AssociatedCen

云企业网。

AssociatedCen
CenId String cen-kojok19xxx******

云企业网实例的ID。

CenOwnerId Long 12345678

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

CenStatus String Attached

云企业网状态。

AssociatedPhysicalConnections Array of AssociatedPhysicalConnection

绑定的物理连接。

AssociatedPhysicalConnection
CircuitCode String 12

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

EnableIpv6 Boolean true
LocalGatewayIp String 116.**.**.**

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

LocalIpv6GatewayIp String 2000:1234:0:a000::5

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

PeerGatewayIp String 116.62.**.**

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

PeerIpv6GatewayIp String 2000:1234:0:a000::6

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

PeeringIpv6SubnetMask String 2000:1234:0:a000::/56

VBR专线侧接口对端的子网俺妈。

PeeringSubnetMask String 255.255.255.252

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

PhysicalConnectionBusinessStatus String Normal

物理专线业务状态。

PhysicalConnectionId String pc-119mfjzm7*********

物理专线ID。

PhysicalConnectionOwnerUid String qfrgrg******

物理专线所有者的UID。

PhysicalConnectionStatus String Normal

物理专线状态。

Status String active

物理专线状态:

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

VBR的VLAN ID。

VlanInterfaceId String ri-kojok19x3j0q6kxxxxxxxxx

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

CircuitCode String longtel001

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

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

VBR的创建时间。

Description String VBR

VBR的描述信息。

DetectMultiplier Long 3

检测时间倍数。

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

取值:3~10

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

高速上云服务实例ID。

EnableIpv6 Boolean true

使用IPv6地址。

LocalGatewayIp String 116.62.**.**

阿里云侧互联IP。

LocalIpv6GatewayIp String 2000:1234:0:a000::3

阿里云侧互联IPv6地址

MinRxInterval Long 100

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

MinTxInterval Long 100

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

Name String test

VBR的名称。

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

计费VBR的超期时间。

PeerGatewayIp String 116.62.**.**

客户侧互联IP。

PeerIpv6GatewayIp String 2000:1234:0:a000::4

客户侧互联IPv6地址。

PeeringIpv6SubnetMask String 2000:1234:0:a000::/55

阿里云侧互联IPv6与客户侧互联IPv6的子网俺妈。

PeeringSubnetMask String 255.255.255.252

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

PhysicalConnectionBusinessStatus String Normal

物理专线业务状态。

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

VBR所属的物理专线的ID。

PhysicalConnectionOwnerUid String usdgbh123f******

物理专线所有者的UID。

PhysicalConnectionStatus String Normal

物理专线状态。

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

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

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

VBR的路由表的ID。

Status String active

VBR状态:

  • Unconfirmed:等待他人确认。
  • Active:正常。
  • Terminating:终止接入中。
  • Terminated:已终止接入。
  • Recovering:恢复中。
  • Deleting:删除中。
TerminationTime String 2017-06-08T12:20:55

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

Type String ecc

物理专线类型。

VbrId String vbr-kojok19xx******

VBR的ID。

VlanId Integer 10

VBR的VLAN ID。

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

VBR的路由器接口的ID。

TotalCount Integer 1

列表条条目数。

PageNumber Integer 1

当前页码。

PageSize Integer 10

每页包含多少条目。

RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

请求ID。

示例

请求示例

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

正常返回示例

XML 格式

<TotalCount>1</TotalCount>
<RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<VirtualBorderRouterSet>
    <VirtualBorderRouterType>
        <PeerGatewayIp>116.62.**.**</PeerGatewayIp>
        <MinRxInterval>100</MinRxInterval>
        <RouteTableId>rtb-bp1nxxxxxxxx*******</RouteTableId>
        <Description>VBR</Description>
        <ActivationTime>2017-06-08T12:20:55</ActivationTime>
        <PhysicalConnectionId>pc-119mfjzm7x******</PhysicalConnectionId>
        <VlanInterfaceId>ri-2zeo3xzyf38r4xx*******</VlanInterfaceId>
        <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
        <VbrId>vbr-kojok19xx******</VbrId>
        <TerminationTime>2017-06-08T12:20:55</TerminationTime>
        <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
        <PhysicalConnectionOwnerUid>usdgbh123f******</PhysicalConnectionOwnerUid>
        <RecoveryTime>2017-06-08T12:20:55</RecoveryTime>
        <Name>test</Name>
        <PeeringIpv6SubnetMask>2000:1234:0:a000::/55</PeeringIpv6SubnetMask>
        <EnableIpv6>true</EnableIpv6>
        <EccId>ecc-h*********</EccId>
        <LocalIpv6GatewayIp>2000:1234:0:a000::3</LocalIpv6GatewayIp>
        <VlanId>10</VlanId>
        <Status>active</Status>
        <CircuitCode>longtel001</CircuitCode>
        <MinTxInterval>100</MinTxInterval>
        <DetectMultiplier>3</DetectMultiplier>
        <PeerIpv6GatewayIp>2000:1234:0:a000::4</PeerIpv6GatewayIp>
        <LocalGatewayIp>116.62.**.**</LocalGatewayIp>
        <Type>ecc</Type>
        <CreationTime>2017-06-08T12:20:55</CreationTime>
        <AccessPointId>ap-cn-kojok1x*********</AccessPointId>
        <PConnVbrExpireTime>2017-06-08T12:20:55</PConnVbrExpireTime>
        <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
    </VirtualBorderRouterType>
    <VirtualBorderRouterType>
        <AssociatedPhysicalConnections>
            <AssociatedPhysicalConnection>
                <Status>active</Status>
                <PeerGatewayIp>116.62.**.**</PeerGatewayIp>
                <CircuitCode>12</CircuitCode>
                <PhysicalConnectionId>pc-119mfjzm7*********</PhysicalConnectionId>
                <VlanInterfaceId>ri-kojok19x3j0q6kxxxxxxxxx</VlanInterfaceId>
                <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
                <PeerIpv6GatewayIp>2000:1234:0:a000::6</PeerIpv6GatewayIp>
                <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
                <PhysicalConnectionOwnerUid>qfrgrg******</PhysicalConnectionOwnerUid>
                <PeeringIpv6SubnetMask>2000:1234:0:a000::/56</PeeringIpv6SubnetMask>
                <LocalGatewayIp>116.**.**.**</LocalGatewayIp>
                <LocalIpv6GatewayIp>2000:1234:0:a000::5</LocalIpv6GatewayIp>
                <VlanId>0</VlanId>
                <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
            </AssociatedPhysicalConnection>
            <AssociatedPhysicalConnection>
                <CenStatus>Attached</CenStatus>
                <CenOwnerId>12345678</CenOwnerId>
                <CenId>cen-kojok19xxx******</CenId>
            </AssociatedPhysicalConnection>
        </AssociatedPhysicalConnections>
        <AssociatedCens>
            <AssociatedCen>
                <Status>active</Status>
                <PeerGatewayIp>116.62.**.**</PeerGatewayIp>
                <CircuitCode>12</CircuitCode>
                <PhysicalConnectionId>pc-119mfjzm7*********</PhysicalConnectionId>
                <VlanInterfaceId>ri-kojok19x3j0q6kxxxxxxxxx</VlanInterfaceId>
                <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
                <PeerIpv6GatewayIp>2000:1234:0:a000::6</PeerIpv6GatewayIp>
                <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
                <PhysicalConnectionOwnerUid>qfrgrg******</PhysicalConnectionOwnerUid>
                <PeeringIpv6SubnetMask>2000:1234:0:a000::/56</PeeringIpv6SubnetMask>
                <LocalGatewayIp>116.**.**.**</LocalGatewayIp>
                <LocalIpv6GatewayIp>2000:1234:0:a000::5</LocalIpv6GatewayIp>
                <VlanId>0</VlanId>
                <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
            </AssociatedCen>
            <AssociatedCen>
                <CenStatus>Attached</CenStatus>
                <CenOwnerId>12345678</CenOwnerId>
                <CenId>cen-kojok19xxx******</CenId>
            </AssociatedCen>
        </AssociatedCens>
    </VirtualBorderRouterType>
</VirtualBorderRouterSet>

JSON 格式

{"TotalCount":"1","RequestId":"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6","PageSize":"10","PageNumber":"1","VirtualBorderRouterSet":{"VirtualBorderRouterType":[{"PeerGatewayIp":"116.62.**.**","MinRxInterval":"100","RouteTableId":"rtb-bp1nxxxxxxxx*******","Description":"VBR","ActivationTime":"2017-06-08T12:20:55","PhysicalConnectionId":"pc-119mfjzm7x******","VlanInterfaceId":"ri-2zeo3xzyf38r4xx*******","PhysicalConnectionStatus":"Normal","VbrId":"vbr-kojok19xx******","TerminationTime":"2017-06-08T12:20:55","PeeringSubnetMask":"255.255.255.252","PhysicalConnectionOwnerUid":"usdgbh123f******","RecoveryTime":"2017-06-08T12:20:55","Name":"test","PeeringIpv6SubnetMask":"2000:1234:0:a000::/55","EnableIpv6":"true","EccId":"ecc-h*********","LocalIpv6GatewayIp":"2000:1234:0:a000::3","VlanId":"10","Status":"active","CircuitCode":"longtel001","MinTxInterval":"100","DetectMultiplier":"3","PeerIpv6GatewayIp":"2000:1234:0:a000::4","LocalGatewayIp":"116.62.**.**","Type":"ecc","CreationTime":"2017-06-08T12:20:55","AccessPointId":"ap-cn-kojok1x*********","PConnVbrExpireTime":"2017-06-08T12:20:55","PhysicalConnectionBusinessStatus":"Normal"},{"AssociatedPhysicalConnections":{"AssociatedPhysicalConnection":[{"Status":"active","PeerGatewayIp":"116.62.**.**","CircuitCode":"12","PhysicalConnectionId":"pc-119mfjzm7*********","VlanInterfaceId":"ri-kojok19x3j0q6kxxxxxxxxx","PhysicalConnectionStatus":"Normal","PeerIpv6GatewayIp":"2000:1234:0:a000::6","PeeringSubnetMask":"255.255.255.252","PhysicalConnectionOwnerUid":"qfrgrg******","PeeringIpv6SubnetMask":"2000:1234:0:a000::/56","LocalGatewayIp":"116.**.**.**","LocalIpv6GatewayIp":"2000:1234:0:a000::5","VlanId":"0","PhysicalConnectionBusinessStatus":"Normal"},{"CenStatus":"Attached","CenOwnerId":"12345678","CenId":"cen-kojok19xxx******"}]},"AssociatedCens":{"AssociatedCen":[{"Status":"active","PeerGatewayIp":"116.62.**.**","CircuitCode":"12","PhysicalConnectionId":"pc-119mfjzm7*********","VlanInterfaceId":"ri-kojok19x3j0q6kxxxxxxxxx","PhysicalConnectionStatus":"Normal","PeerIpv6GatewayIp":"2000:1234:0:a000::6","PeeringSubnetMask":"255.255.255.252","PhysicalConnectionOwnerUid":"qfrgrg******","PeeringIpv6SubnetMask":"2000:1234:0:a000::/56","LocalGatewayIp":"116.**.**.**","LocalIpv6GatewayIp":"2000:1234:0:a000::5","VlanId":"0","PhysicalConnectionBusinessStatus":"Normal"},{"CenStatus":"Attached","CenOwnerId":"12345678","CenId":"cen-kojok19xxx******"}]}}]}}

错误码

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

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