调用DescribeVirtualBorderRouters接口查询已创建的VBR实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DescribeVirtualBorderRouters | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VBR 所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
PageNumber | integer | 否 | 列表的页码,默认值为 1。 | 1 |
PageSize | integer | 否 | 分页查询时每页的行数,最大值为 50,默认值为 10。 | 10 |
Filter | array<object> | 否 | 过滤信息。 | |
object | 否 | 过滤信息。 | ||
Key | string | 否 | 过滤条件,最多可提供 5 个过滤条件。支持如下过滤条件:
| Status |
Value | array | 否 | 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,每个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 | |
string | 否 | 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,每个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 | Active | |
IncludeCrossAccountVbr | boolean | 否 | 是否包含跨账号的边界路由器。
| false |
ResourceGroupId | string | 否 | 资源组 ID。 关于资源组的更多信息,请参见什么是资源组。 | rg-acfmxazb4ph6aiy**** |
Tags | array<object> | 否 | 资源的标签。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 资源的标签键。至少输入 1 个标签键,最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。 一个标签键最多支持 128 个字符,不能以 | FinanceDept |
Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。 最多支持 128 个字符,不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 指定的RegionId不存在。请检查该参数是否正确。 |
404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | 该过滤器的Key不支持:Filter.X.key。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-04-17 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-12-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-11 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2023-07-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |