调用DescribeVirtualBorderRoutersForPhysicalConnection接口查询指定物理专线下的VBR实例,包括物理专线所有者的VBR实例和其他账号的VBR实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVirtualBorderRoutersForPhysicalConnection | 要执行的操作。 取值: DescribeVirtualBorderRoutersForPhysicalConnection。 |
PhysicalConnectionId | String | 是 | pc-119mfj**** | 物理专线的ID。 |
RegionId | String | 是 | cn-shanghai | 物理专线所在的地域。 您可以通过调用DescribeRegions 接口获取地域ID。 |
Filter.N.Key | String | 否 | Status | 过滤条件,最多可提供5个过滤条件。支持如下过滤条件:
|
Filter.N.Value.N | RepeatList | 否 | Active | 根据Key指定过滤值。一个Key支持指定多个过滤值,每个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 |
PageNumber | Integer | 否 | 1 | 列表的页码,默认值为1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页的行数,最大值为50,默认值为10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
VirtualBorderRouterForPhysicalConnectionSet | Array of VirtualBorderRouterForPhysicalConnectionType | 查询到的VBR实例信息合集。 |
|
VirtualBorderRouterForPhysicalConnectionType | |||
ActivationTime | String | 2017-06-08T12:20:55 | VBR第一次激活的时间。 |
Bandwidth | String | 10 | 物理专线下绑定的边界路由器带宽值,单位:Mbps。 |
BandwidthStatus | String | Active | 带宽生效状态。
|
CircuitCode | String | longtel0** | 运营商为物理专线提供的电路编码。 |
CreationTime | String | 2021-06-08T12:20:55 | 创建VBR的时间。 |
EccId | String | ecc-sjghe**** | 高速上云服务实例ID。 |
EnableIpv6 | Boolean | true | 是否启用IPv6。
|
LocalGatewayIp | String | 192.168.XX.X | VBR实例的阿里云侧互联IPv4地址。 |
LocalIpv6GatewayIp | String | 2001:0db8:3c4d:0015:0000:00**:****:1a2b | VBR实例的阿里云侧互联IPv6地址。 |
PConnVbrBussinessStatus | String | Normal | 物理专线绑定的VBR运行状态。
|
PConnVbrChargeType | String | PrePaid | 物理专线绑定的边界路由器付费类型。
|
PConnVbrExpireTime | String | 2021-06-10T12:20:55 | 物理专线绑定的VBR到期时间。 |
PeerGatewayIp | String | 162.62.XX.XX | VBR实例的客户侧互联IPv4地址。 |
PeerIpv6GatewayIp | String | 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b | VBR实例的客户侧互联IPv6地址。 该属性只允许VBR所有者指定或者修改。 为物理专线所有者创建VBR实例时必填,为其他账号创建VBR实例时无需填写。 |
PeeringIpv6SubnetMask | String | 2408:4004:cc:400::/56 | VBR实例的阿里云侧和客户侧互联IPv6的子网掩码。 两个IPv6地址必须位于同一个子网。 |
PeeringSubnetMask | String | 255.255.255.0 | VBR实例的阿里云侧和客户侧互联IPv4的子网掩码。 两个IPv4地址必须位于同一个子网。 |
RecoveryTime | String | 2021-06-08T12:20:55 | VBR最近一次从Terminated状态恢复到Active状态的时间。 |
Status | String | Active | VBR实例状态。
|
TerminationTime | String | 2021-06-07T12:20:55 | VBR最近一次被终止的时间。 |
Type | String | pconnVBR | VBR类型。 |
VbrId | String | vbr-bp16ksp61j7e0tk***** | VBR实例ID。 |
VbrOwnerUid | Long | 1234567890 | VBR所有者的账号ID。 VBR和物理专线的所有者相同时该参数为空。 |
VlanId | Integer | 1678 | VBR实例的VLAN ID。 |
TotalCount | Integer | 2 | 列表条目数。 |
PageNumber | Integer | 1 | 列表的页码,默认值为1。 |
PageSize | Integer | 10 | 分页查询时每页的行数,最大值为50,默认值为10。 |
RequestId | String | 7C5AE8B3-A2D8-428D-A2FF-93A225C0821E | 请求ID。 |
示例
请求示例
1 2 3 4 | http(s): //[Endpoint]/?Action=DescribeVirtualBorderRoutersForPhysicalConnection &PhysicalConnectionId=pc-119mfj**** &RegionId=cn-shanghai &<公共请求参数> |
正常返回示例
XML
格式
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | <DescribeVirtualBorderRoutersForPhysicalConnectionResponse> <TotalCount> 2 </TotalCount> <PageSize> 10 </PageSize> <RequestId>7C5AE8B3-A2D8-428D-A2FF-93A225C0821E</RequestId> <PageNumber> 1 </PageNumber> <VirtualBorderRouterForPhysicalConnectionSet> <VirtualBorderRouterForPhysicalConnectionType> <Status>Active</Status> <PeerGatewayIp> 162.62 .XX.XX</PeerGatewayIp> <ActivationTime> 2017 - 06 -08T12: 20 : 55 </ActivationTime> <VbrOwnerUid> 1234567890 </VbrOwnerUid> <CircuitCode>longtel0**</CircuitCode> <PeerIpv6GatewayIp> 2001 :XXXX:3c4d: 0015 : 0000 : 0000 : 0000 :1a2b</PeerIpv6GatewayIp> <VbrId>vbr-bp16ksp61j7e0tk*****</VbrId> <PConnVbrChargeType>PrePaid</PConnVbrChargeType> <PeeringSubnetMask> 255.255 . 255.0 </PeeringSubnetMask> <TerminationTime> 2021 - 06 -07T12: 20 : 55 </TerminationTime> <EnableIpv6> true </EnableIpv6> <PeeringIpv6SubnetMask> 2408 : 4004 :cc: 400 ::/ 56 </PeeringIpv6SubnetMask> <RecoveryTime> 2021 - 06 -08T12: 20 : 55 </RecoveryTime> <LocalGatewayIp> 192.168 .XX.X</LocalGatewayIp> <Type>pconnVBR</Type> <Bandwidth> 10 </Bandwidth> <CreationTime> 2021 - 06 -08T12: 20 : 55 </CreationTime> <BandwidthStatus>Active</BandwidthStatus> <EccId>ecc-sjghe****</EccId> <PConnVbrExpireTime> 2021 - 06 -10T12: 20 : 55 </PConnVbrExpireTime> <LocalIpv6GatewayIp> 2001 :0db8:3c4d: 0015 : 0000 : 00 **:****:1a2b</LocalIpv6GatewayIp> <VlanId> 1678 </VlanId> <PConnVbrBussinessStatus>Normal</PConnVbrBussinessStatus> </VirtualBorderRouterForPhysicalConnectionType> </VirtualBorderRouterForPhysicalConnectionSet> </DescribeVirtualBorderRoutersForPhysicalConnectionResponse> |
JSON
格式
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | { "DescribeVirtualBorderRoutersForPhysicalConnection" : { "TotalCount" : 2 , "PageSize" : 10 , "RequestId" : "7C5AE8B3-A2D8-428D-A2FF-93A225C0821E" , "PageNumber" : 1 , "VirtualBorderRouterForPhysicalConnectionSet" : { "VirtualBorderRouterForPhysicalConnectionType" : { "Status" : "Active" , "PeerGatewayIp" : "162.62.XX.XX" , "ActivationTime" : "2017-06-08T12:20:55" , "VbrOwnerUid" : 1234567890 , "CircuitCode" : "longtel0**" , "PeerIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b" , "VbrId" : "vbr-bp16ksp61j7e0tk*****" , "PConnVbrChargeType" : "PrePaid" , "PeeringSubnetMask" : "255.255.255.0" , "TerminationTime" : "2021-06-07T12:20:55" , "EnableIpv6" : true , "PeeringIpv6SubnetMask" : "2408:4004:cc:400::/56" , "RecoveryTime" : "2021-06-08T12:20:55" , "LocalGatewayIp" : "192.168.XX.X" , "Type" : "pconnVBR" , "Bandwidth" : 10 , "CreationTime" : "2021-06-08T12:20:55" , "BandwidthStatus" : "Active" , "EccId" : "ecc-sjghe****" , "PConnVbrExpireTime" : "2021-06-10T12:20:55" , "LocalIpv6GatewayIp" : "2001:0db8:3c4d:0015:0000:00**:****:1a2b" , "VlanId" : 1678 , "PConnVbrBussinessStatus" : "Normal" } } } } |
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidPhysicalConnectionId.NotFound | The specified PhysicalConnectionId does not belong to user. | 该物理专线不属于您的账号。 |
400 | InvalidPhysicalConnectionId.NotFound | The specified physicalConnection is not found. | 没有找到此专线ID对应的物理专线。 |
访问错误中心查看更多错误码。