调用DescribeVirtualBorderRouters接口查询已创建的VBR实例。

调试

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

请求参数

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

系统规定参数。取值：DescribeVirtualBorderRouters。
RegionId String 是 cn-shanghai

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

PageNumber Integer 否 1

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

PageSize Integer 否 10

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

Filter.N.Key String 否 Status

过滤条件，最多可提供5个过滤条件。支持如下过滤条件：

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

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

是否包含跨账号的边界路由器。

  • true：包含。
  • false（默认值）：不包含。

返回数据

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

请求ID。
PageNumber Integer 1

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

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

列表条目数。
VirtualBorderRouterSet Array of VirtualBorderRouterType

查询到的VBR合集。

VirtualBorderRouterType
CreationTime String 2020-06-08T12:20:55

VBR的创建时间。
Status String active

VBR实例状态。

  • unconfirmed：等待他人确认。
  • active：正常。
  • terminating：终止接入中。
  • terminated：已终止接入。
  • recovering：恢复中。
  • deleting：删除中。
Type String pconnVBR

VBR类型。
MinTxInterval Long 300

配置BFD报文的发送间隔，取值：200～1000，单位为ms。
PeerIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

VBR实例的客户侧互联IPv6地址。
PConnVbrExpireTime String 2021-06-08T12:20:55

计费VBR的超期时间。
PhysicalConnectionOwnerUid String 1688000000000****

物理专线所属的账号ID。
ActivationTime String 2021-06-08T12:20:55

VBR第一次激活的时间。
PhysicalConnectionBusinessStatus String Normal

物理专线业务状态。

  • Normal：正常。
  • FinancialLocked：欠费锁定。
Description String desc

VBR的描述信息。
TerminationTime String 2021-06-08T12:20:55

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

配置BFD报文的接收间隔，取值：200～1000，单位为ms。
PeerGatewayIp String 192.168.XX.XX

VBR实例的客户侧互联IPv4地址。
Name String test

VBR实例名称。
VbrId String vbr-bp1jcg5cmxjbl9xgc****

VBR实例ID。
VlanId Integer 10

VBR实例的VLAN ID。
VlanInterfaceId String ri-2zeo3xzyf38r4xx****

VBR的路由器接口的ID。
CircuitCode String longtel0****

运营商为物理专线提供的电路编码。
LocalIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

VBR实例的阿里云侧互联IPv6地址。
LocalGatewayIp String 192.168.XX.XX

VBR实例的阿里云侧互联IPv4地址。
PeeringSubnetMask String 255.255.255.252

VBR实例的阿里云侧互联IPv4和客户侧互联IPv4的子网掩码。
EnableIpv6 Boolean false

是否启用IPv6。

  • true：开启。
  • false：关闭。
RouteTableId String rtb-bp1****

VBR的路由表ID。
DetectMultiplier Long 3

检测时间倍数。

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

取值：3～10。
EccId String ecc-h****

高速上云服务实例ID。
CloudBoxInstanceId String cb-****

云盒实例ID。
RecoveryTime String 2021-05-08T12:20:55

VBR最近一次从terminated状态恢复到active状态的时间。
PhysicalConnectionStatus String Normal

物理专线状态。

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

VBR实例的阿里云侧互联IPv6与客户侧互联IPv6的子网掩码。
AccessPointId String ap-cn-kojok1x****

物理专线接入点的ID。
PConnVbrChargeType String PrePaid

物理专线绑定的边界路由器付费类型。

  • PrePaid：预付费，包年包月。选择该类付费方式时，您必须确认自己的账号支持余额支付或信用支付。
  • PostPaid：按量付费。
PhysicalConnectionId String pc-119mfjzm7x****

VBR所属的物理专线的ID。
AssociatedPhysicalConnections Array of AssociatedPhysicalConnection

关联的物理专线信息。
AssociatedPhysicalConnection
Status String active

VBR实例状态。

  • unconfirmed：等待他人确认。
  • active：正常。
  • terminating：终止接入中。
  • terminated：已终止接入。
  • recovering：恢复中。
  • deleting：删除中。
VlanInterfaceId String ri-kojok19x3j0q6k****

VBR的路由器接口ID，可以作为VBR路由的下一跳。
CircuitCode String longtel0**

运营商为物理专线提供的电路编码。
PeerIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

VBR实例的客户侧互联IPv6地址。
LocalIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

VBR实例的阿里云侧互联IPv6地址。
PhysicalConnectionOwnerUid String 12345678****

物理专线所有者的账号ID。
LocalGatewayIp String 192.168.XX.XX

VBR实例的阿里云侧互联IPv4地址。
PhysicalConnectionBusinessStatus String Normal

物理专线业务状态。

  • Normal：正常。
  • FinancialLocked：欠费锁定。
PeeringSubnetMask String 255.255.255.252

VBR实例的阿里云侧和客户侧互联IPv4的子网掩码。

两个IPv4地址必须位于同一个子网。

EnableIpv6 Boolean true

是否启用IPv6。

  • true：开启。
  • false：关闭。
PhysicalConnectionStatus String Enabled

物理专线状态。

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

VBR实例的客户侧互联IPv4地址。
PeeringIpv6SubnetMask String 2408:4004:cc:400::/56

VBR实例的阿里云侧和客户侧互联IPv6的子网掩码。

两个IPv6地址必须位于同一个子网。

PhysicalConnectionId String pc-119mfjzm7****

物理专线ID。
VlanId String 0

VBR实例的VLAN ID。
AssociatedCens Array of AssociatedCen

关联的云企业网实例信息。
AssociatedCen
CenOwnerId Long 1688000000000****

云企业网实例所属账号的ID。
CenId String cen-kojok19xxx****

云企业网实例ID。
CenStatus String Attached

云企业网状态。

  • Attached：已关联。
  • Attaching：关联中。
  • Detached：已取消关联。
  • Detaching：取消关联中。
  • 空：未关联。
Bandwidth Integer 50

VBR实例的带宽值，单位：Mbps。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVirtualBorderRouters
&RegionId=cn-shanghai
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"Status","Value":["Active"]}]
&IncludeCrossAccountVbr=false
&公共请求参数

正常返回示例

XML格式

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

<DescribeVirtualBorderRoutersResponse>
    <RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <VirtualBorderRouterSet>
        <CreationTime>2020-06-08T12:20:55</CreationTime>
        <Status>active</Status>
        <Type>pconnVBR</Type>
        <MinTxInterval>300</MinTxInterval>
        <PeerIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</PeerIpv6GatewayIp>
        <PConnVbrExpireTime>2021-06-08T12:20:55</PConnVbrExpireTime>
        <PhysicalConnectionOwnerUid>1688000000000****</PhysicalConnectionOwnerUid>
        <ActivationTime>2021-06-08T12:20:55</ActivationTime>
        <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
        <Description>desc</Description>
        <TerminationTime>2021-06-08T12:20:55</TerminationTime>
        <MinRxInterval>300</MinRxInterval>
        <PeerGatewayIp>192.168.XX.XX</PeerGatewayIp>
        <Name>test</Name>
        <VbrId>vbr-bp1jcg5cmxjbl9xgc****</VbrId>
        <VlanId>10</VlanId>
        <VlanInterfaceId>ri-2zeo3xzyf38r4xx****</VlanInterfaceId>
        <CircuitCode>longtel0****</CircuitCode>
        <LocalIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</LocalIpv6GatewayIp>
        <LocalGatewayIp>192.168.XX.XX</LocalGatewayIp>
        <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
        <EnableIpv6>false</EnableIpv6>
        <RouteTableId>rtb-bp1****</RouteTableId>
        <DetectMultiplier>3</DetectMultiplier>
        <EccId>ecc-h****</EccId>
        <CloudBoxInstanceId>cb-****</CloudBoxInstanceId>
        <RecoveryTime>2021-05-08T12:20:55</RecoveryTime>
        <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
        <PeeringIpv6SubnetMask>2000:1234:0:a000::/55</PeeringIpv6SubnetMask>
        <AccessPointId>ap-cn-kojok1x****</AccessPointId>
        <PConnVbrChargeType>PrePaid</PConnVbrChargeType>
        <PhysicalConnectionId>pc-119mfjzm7x****</PhysicalConnectionId>
        <AssociatedPhysicalConnections>
            <Status>active</Status>
            <VlanInterfaceId>ri-kojok19x3j0q6k****</VlanInterfaceId>
            <CircuitCode>longtel0**</CircuitCode>
            <PeerIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</PeerIpv6GatewayIp>
            <LocalIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</LocalIpv6GatewayIp>
            <PhysicalConnectionOwnerUid>12345678****</PhysicalConnectionOwnerUid>
            <LocalGatewayIp>192.168.XX.XX</LocalGatewayIp>
            <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
            <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
            <EnableIpv6>true</EnableIpv6>
            <PhysicalConnectionStatus>Enabled</PhysicalConnectionStatus>
            <PeerGatewayIp>116.62.XX.XX</PeerGatewayIp>
            <PeeringIpv6SubnetMask>2408:4004:cc:400::/56</PeeringIpv6SubnetMask>
            <PhysicalConnectionId>pc-119mfjzm7****</PhysicalConnectionId>
            <VlanId>0</VlanId>
        </AssociatedPhysicalConnections>
        <AssociatedCens>
            <CenId>cen-kojok19xxx****</CenId>
            <CenStatus>Attached</CenStatus>
        </AssociatedCens>
        <Bandwidth>50</Bandwidth>
    </VirtualBorderRouterSet>
</DescribeVirtualBorderRoutersResponse>

JSON格式

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

{
  "RequestId" : "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "VirtualBorderRouterSet" : [ {
    "CreationTime" : "2020-06-08T12:20:55",
    "Status" : "active",
    "Type" : "pconnVBR",
    "MinTxInterval" : 300,
    "PeerIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
    "PConnVbrExpireTime" : "2021-06-08T12:20:55",
    "PhysicalConnectionOwnerUid" : "1688000000000****",
    "ActivationTime" : "2021-06-08T12:20:55",
    "PhysicalConnectionBusinessStatus" : "Normal",
    "Description" : "desc",
    "TerminationTime" : "2021-06-08T12:20:55",
    "MinRxInterval" : 300,
    "PeerGatewayIp" : "192.168.XX.XX",
    "Name" : "test",
    "VbrId" : "vbr-bp1jcg5cmxjbl9xgc****",
    "VlanId" : 10,
    "VlanInterfaceId" : "ri-2zeo3xzyf38r4xx****",
    "CircuitCode" : "longtel0****",
    "LocalIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
    "LocalGatewayIp" : "192.168.XX.XX",
    "PeeringSubnetMask" : "255.255.255.252",
    "EnableIpv6" : false,
    "RouteTableId" : "rtb-bp1****",
    "DetectMultiplier" : 3,
    "EccId" : "ecc-h****",
    "CloudBoxInstanceId" : "cb-****",
    "RecoveryTime" : "2021-05-08T12:20:55",
    "PhysicalConnectionStatus" : "Normal",
    "PeeringIpv6SubnetMask" : "2000:1234:0:a000::/55",
    "AccessPointId" : "ap-cn-kojok1x****",
    "PConnVbrChargeType" : "PrePaid",
    "PhysicalConnectionId" : "pc-119mfjzm7x****",
    "AssociatedPhysicalConnections" : [ {
      "Status" : "active",
      "VlanInterfaceId" : "ri-kojok19x3j0q6k****",
      "CircuitCode" : "longtel0**",
      "PeerIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
      "LocalIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
      "PhysicalConnectionOwnerUid" : "12345678****",
      "LocalGatewayIp" : "192.168.XX.XX",
      "PhysicalConnectionBusinessStatus" : "Normal",
      "PeeringSubnetMask" : "255.255.255.252",
      "EnableIpv6" : true,
      "PhysicalConnectionStatus" : "Enabled",
      "PeerGatewayIp" : "116.62.XX.XX",
      "PeeringIpv6SubnetMask" : "2408:4004:cc:400::/56",
      "PhysicalConnectionId" : "pc-119mfjzm7****",
      "VlanId" : "0"
    } ],
    "AssociatedCens" : [ {
      "CenId" : "cen-kojok19xxx****",
      "CenStatus" : "Attached"
    } ],
    "Bandwidth" : 50
  } ]
}

错误码

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

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