DescribeVirtualBorderRouters - 查询已创建的边界路由器(VBR)

更新时间:2025-03-10 18:38:40

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

调试

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

授权信息

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

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

请求参数

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

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

cn-shanghai
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

10
Filterarray<object>

过滤信息。

object

过滤信息。

Keystring

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

  • PhysicalConnectionId:物理专线实例 ID。

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

  • Status:边界路由器状态。

  • Name:边界路由器名称。

  • AccessPointId:接入点 ID。

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

  • type:物理专线类型。

Status
Valuearray

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

string

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

Active
IncludeCrossAccountVbrboolean

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

  • true:包含。

  • false(默认值):不包含。

false
ResourceGroupIdstring

资源组 ID。

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

rg-acfmxazb4ph6aiy****
Tagsarray<object>

资源的标签。

object

标签。

Keystring

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

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

FinanceDept
Valuestring

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

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

FinanceJoshua

返回参数

名称类型描述示例值
名称类型描述示例值
object

VBR 信息。

RequestIdstring

请求 ID。

DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

10
TotalCountinteger

列表条目数。

1
VirtualBorderRouterSetarray<object>

查询到的 VBR 合集。

VirtualBorderRouterTypeobject

VBR 的创建时间。

CreationTimestring

VBR 的创建时间。

2020-06-08T12:20:55
Statusstring

VBR 实例状态。

  • unconfirmed:等待他人确认。

  • active:正常。

  • terminating:终止接入中。

  • terminated:已终止接入。

  • recovering:恢复中。

  • deleting:删除中。

active
Typestring

VBR 类型。

pconnVBR
MinTxIntervallong

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

300
PeerIpv6GatewayIpstring

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

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

计费 VBR 的超期时间。

2021-06-08T12:20:55
PhysicalConnectionOwnerUidstring

物理专线所属的账号 ID。

1688000000000****
ActivationTimestring

VBR 第一次激活的时间。

2021-06-08T12:20:55
PhysicalConnectionBusinessStatusstring

物理专线业务状态。

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
Descriptionstring

VBR 的描述信息。

desc
TerminationTimestring

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

2021-06-08T12:20:55
MinRxIntervallong

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

300
PeerGatewayIpstring

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

192.168.XX.XX
Namestring

VBR 实例名称。

test
VbrIdstring

VBR 实例 ID。

vbr-bp1jcg5cmxjbl9xgc****
VlanIdinteger

VBR 实例的 VLAN ID。

10
VlanInterfaceIdstring

VBR 的路由器接口的 ID。

ri-2zeo3xzyf38r4xx****
CircuitCodestring

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

longtel0****
LocalIpv6GatewayIpstring

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

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

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

192.168.XX.XX
PeeringSubnetMaskstring

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

255.255.255.252
EnableIpv6boolean

是否启用 IPv6。

  • true:开启。

  • false:关闭。

false
RouteTableIdstring

VBR 的路由表 ID。

rtb-bp1****
DetectMultiplierlong

检测时间倍数。

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

取值:3~10

3
EccIdstring

高速上云服务实例 ID。

ecc-h****
CloudBoxInstanceIdstring

云盒实例 ID。

cb-****
RecoveryTimestring

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

2021-05-08T12:20:55
PhysicalConnectionStatusstring

物理专线状态。

  • Initial:申请中。

  • Approved:审批通过。

  • Allocating:正在分配资源。

  • Allocated:接入施工中。

  • Confirmed:等待用户确认。

  • Enabled:已开通。

  • Rejected:申请被拒绝。

  • Canceled:已取消。

  • Allocation Failed:资源分配失败。

  • Terminated:已终止。

Normal
PeeringIpv6SubnetMaskstring

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

2000:1234:0:a000::/55
AccessPointIdstring

物理专线接入点的 ID。

ap-cn-kojok1x****
PConnVbrChargeTypestring

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

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

VBR 所属的物理专线的 ID。

pc-119mfjzm7x****
AssociatedPhysicalConnectionsarray<object>

关联的物理专线信息。

AssociatedPhysicalConnectionobject

关联的物理专线信息。

Statusstring

VBR 实例状态。

  • unconfirmed:等待他人确认。

  • active:正常。

  • terminating:终止接入中。

  • terminated:已终止接入。

  • recovering:恢复中。

  • deleting:删除中。

active
VlanInterfaceIdstring

VBR 的路由器接口 ID,可以作为 VBR 路由的下一跳。

ri-kojok19x3j0q6k****
CircuitCodestring

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

longtel0**
PeerIpv6GatewayIpstring

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

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

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

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

物理专线所有者的账号 ID。

12345678****
LocalGatewayIpstring

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

192.168.XX.XX
PhysicalConnectionBusinessStatusstring

物理专线业务状态。

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
PeeringSubnetMaskstring

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

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

255.255.255.252
EnableIpv6boolean

是否启用 IPv6。

  • true:开启。

  • false:关闭。

true
PhysicalConnectionStatusstring

物理专线状态。

  • Initial:申请中。

  • Approved:审批通过。

  • Allocating:正在分配资源。

  • Allocated:接入施工中。

  • Confirmed:等待用户确认。

  • Enabled:已开通。

  • Rejected:申请被拒绝。

  • Canceled:已取消。

  • Allocation Failed:资源分配失败。

  • Terminated:已终止。

Enabled
PeerGatewayIpstring

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

116.62.XX.XX
PeeringIpv6SubnetMaskstring

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

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

2408:4004:cc:400::/56
PhysicalConnectionIdstring

物理专线 ID。

pc-119mfjzm7****
VlanIdstring

VBR 实例的 VLAN ID。

0
AssociatedCensarray<object>

关联的云企业网实例信息。

AssociatedCenobject

实例信息。

CenOwnerIdlong

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

1688000000000****
CenIdstring

云企业网实例 ID。

cen-kojok19xxx****
CenStatusstring

云企业网状态。

  • Attached:已关联。

  • Attaching:关联中。

  • Detached:已取消关联。

  • Detaching:取消关联中。

  • 空:未关联。

Attached
Bandwidthinteger

VBR 实例的带宽值,单位:Mbps。

50
ResourceGroupIdstring

资源组 ID。

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

rg-acfmxazb4ph6aiy****
Tagsarray<object>

资源的标签。

Tagsobject

标签。

Keystring

资源的标签键。

FinanceDept
Valuestring

资源的标签值。

FinanceJoshua
EcrIdstring

关联的专线网关实例 ID。

ecr-7vrbqv9lcgvzqbwwkm
SitelinkEnableboolean

是否允许 IDC 间业务访问。取值:

  • true:是。
  • false:否。
说明
如果不传入任何取值表示不允许 IDC 间业务访问。
false
EcrAttatchStatusstring

专线网关关联状态。

  • Attached:已关联。

  • Attaching:关联中。

  • Detached:已取消关联。

  • Detaching:取消关联中。

  • :未关联。

Attached
EcrOwnerIdstring

ECR 实例所属阿里云账号(主账号)ID。

192732132151xxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "VirtualBorderRouterSet": {
    "VirtualBorderRouterType": [
      {
        "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": {
          "AssociatedPhysicalConnection": [
            {
              "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": {
          "AssociatedCen": [
            {
              "CenOwnerId": 0,
              "CenId": "cen-kojok19xxx****",
              "CenStatus": "Attached"
            }
          ]
        },
        "Bandwidth": 50,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "EcrId": "ecr-7vrbqv9lcgvzqbwwkm",
        "SitelinkEnable": false,
        "EcrAttatchStatus": "Attached",
        "EcrOwnerId": "192732132151xxxx"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400OperationFailed.InternalErrorThe request processing has failed due to some unknown error.未知错误,请重试操作,错误仍存在请提交工单处理。
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。

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2024-11-12OpenAPI 错误码发生变更查看变更详情
2024-04-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-12-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-09-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-07-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等