全部产品
Search
文档中心

专有网络 VPC:DescribeVirtualBorderRoutersForPhysicalConnection - 查询边界路由器(VBR)

更新时间:Feb 22, 2024

查询指定物理专线下的边界路由器(VBR),包括物理专线所有者的VBR和其他账号的VBR。

调试

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

授权信息

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

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

请求参数

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

物理专线所在的地域。 您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
PhysicalConnectionIdstring

物理专线的 ID。

pc-119mfj****
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

10
Filterobject []

过滤条件列表。

Keystring

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

  • PhysicalConnectionId:物理专线实例 ID。

  • VbrId:边界路由器实例 ID。

  • Status:边界路由器状态。

  • Name:边界路由器名称。

  • AccessPointId:接入点 ID。

  • eccId:高速上云服务实例 ID。

  • type:边界路由器类型。

Status
Valuearray

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

string

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

Active

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

7C5AE8B3-A2D8-428D-A2FF-93A225C0821E
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

10
TotalCountinteger

列表条目数。

1
VirtualBorderRouterForPhysicalConnectionSetobject []

查询到的 VBR 实例信息合集。

Statusstring

VBR 实例状态。取值:

  • unconfirmed:等待他人确认。

  • active:正常。

  • terminating:终止接入中。

  • terminated:已终止接入。

  • recovering:恢复中。

  • deleting:删除中。

Active
CreationTimestring

创建 VBR 的时间。

2021-06-08T12:20:55
Typestring

VBR 类型。

pconnVBR
PeerIpv6GatewayIpstring

VBR 实例的客户侧互联 IPv6 地址。

为物理专线所有者创建 VBR 实例时必填,为其他账号创建 VBR 实例时无需填写。

2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
CircuitCodestring

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

longtel0**
LocalIpv6GatewayIpstring

VBR 实例的阿里云侧互联 IPv6 地址。

ipv6bw-uf6hcyzu65v98v3du****
PConnVbrExpireTimestring

物理专线绑定的 VBR 到期时间。

2021-06-10T12:20:55
LocalGatewayIpstring

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

192.168.XX.X
BandwidthStatusstring

带宽生效状态。取值:

  • Active:正常。

  • Inactive:异常。

Active
ActivationTimestring

VBR 第一次激活的时间。

2021-06-08T12:20:55
VbrOwnerUidlong

VBR 所有者的账号 ID。

VBR 和物理专线的所有者相同时该参数为空。

253460731706911258
PeeringSubnetMaskstring

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

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

255.255.255.0
EnableIpv6boolean

是否启用 IPv6。取值:

  • true:开启。

  • false:关闭。

true
EccIdstring

高速上云服务实例 ID。

ecc-sjghe****
Bandwidthstring

物理专线下绑定的边界路由器带宽值,单位:Mbps。

10
RecoveryTimestring

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

2021-06-08T12:20:55
TerminationTimestring

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

2021-06-07T12:20:55
PConnVbrBussinessStatusstring

物理专线绑定的 VBR 运行状态。取值:

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
PeerGatewayIpstring

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

162.62.XX.XX
PeeringIpv6SubnetMaskstring

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

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

2408:4004:cc:400::/56
VbrIdstring

VBR 实例 ID。

vbr-bp16ksp61j7e0tk****
PConnVbrChargeTypestring

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

  • PrePaid:预付费,包年包月。选择该类付费方式时,您必须确认自己的账号支持余额支付或信用支付。

  • PostPaid:按量付费。

PrePaid
VlanIdinteger

VBR 实例的 VLAN ID。

1678

示例

正常返回示例

JSON格式

{
  "RequestId": "7C5AE8B3-A2D8-428D-A2FF-93A225C0821E",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "VirtualBorderRouterForPhysicalConnectionSet": {
    "VirtualBorderRouterForPhysicalConnectionType": [
      {
        "Status": "Active",
        "CreationTime": "2021-06-08T12:20:55",
        "Type": "pconnVBR",
        "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
        "CircuitCode": "longtel0**",
        "LocalIpv6GatewayIp": "ipv6bw-uf6hcyzu65v98v3du****",
        "PConnVbrExpireTime": "2021-06-10T12:20:55",
        "LocalGatewayIp": "192.168.XX.X",
        "BandwidthStatus": "Active",
        "ActivationTime": "2021-06-08T12:20:55",
        "VbrOwnerUid": 253460731706911260,
        "PeeringSubnetMask": "255.255.255.0",
        "EnableIpv6": true,
        "EccId": "ecc-sjghe****",
        "Bandwidth": "10",
        "RecoveryTime": "2021-06-08T12:20:55",
        "TerminationTime": "2021-06-07T12:20:55",
        "PConnVbrBussinessStatus": "Normal",
        "PeerGatewayIp": "162.62.XX.XX",
        "PeeringIpv6SubnetMask": "2408:4004:cc:400::/56",
        "VbrId": "vbr-bp16ksp61j7e0tk****",
        "PConnVbrChargeType": "PrePaid",
        "VlanId": 1678
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidPhysicalConnectionId.NotFoundThe specified physicalConnection is not found.没有找到此专线ID对应的物理专线。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
404InvalidPhysicalConnectionId.NotFoundThe specified PhysicalConnectionId does not belong to user.该物理专线不属于您的账号。

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

变更历史

变更时间变更内容概要操作
2023-09-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404