Queries virtual border routers (VBRs).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:DescribeVirtualBorderRouters | list |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region in which the VBR is deployed. You can call the DescribeRegions operation to obtain the region ID. | cn-shanghai |
| PageNumber | integer | No | The page number. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Maximum value: 50. Default value: 10. | 10 |
| Filter | array<object> | No | The information about the filter. | |
| object | No | |||
| Key | string | No | The filter conditions. You can specify up to five filter conditions. Valid values:
| Status |
| Value | array | No | The filter values for keys. You can specify multiple filter values for one key. The logical operator between filter values is OR. If one filter value is matched, the filter condition is matched. | |
| string | No | The filter value for the key. You can specify multiple filter values for one key. The logical operator between filter values is OR. If one filter value is matched, the filter condition is matched. | Active | |
| IncludeCrossAccountVbr | boolean | No | Specifies whether cross-account VBRs are included.
| false |
| ResourceGroupId | string | No | The resource group ID. For more information about resource groups, see What is a resource group? | rg-acfmxazb4ph6aiy**** |
| Tags | array<object> | No | The list of tags. | |
| object | No | The tags. | ||
| Key | string | No | The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string. The key cannot exceed 128 characters in length, and cannot start with | FinanceDept |
| Value | string | No | The tag value. You can specify at most 20 tag values. The tag value can be an empty string. The tag value cannot exceed 128 characters in length, and cannot start with | FinanceJoshua |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": ""
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | The RegionId parameter is set to an invalid value. Specify a valid value and try again. |
| 404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | Filter.X.key is not supported. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-12 | The Error code has changed | View Change Details |
| 2024-04-17 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-12-26 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-09-11 | API Description Update. The Error code has changed | View Change Details |
| 2023-07-20 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |