Queries advertised Border Gateway Protocol (BGP) networks.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeBgpNetworks |
The operation that you want to perform. Set the value to DescribeBgpNetworks. |
RouterId | String | No | vrt-bp1lhl0taikrteen8**** |
The ID of the virtual border router (VBR). |
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the BGP group is deployed. You can call the DescribeRegions operation to query the most recent region list. |
PageNumber | Integer | No | 1 |
The number of the page to return. Default value: 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Maximum value: 50. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageSize | Integer | 10 |
The number of entries returned per page. |
RequestId | String | 6F513A15-669F-419D-B511-08A85292059B |
The ID of the request. |
PageNumber | Integer | 1 |
The page number of the returned page. |
TotalCount | Integer | 2 |
The total number of advertised BGP networks. |
BgpNetworks | Array of BgpNetwork |
BGP networks. |
|
BgpNetwork | |||
Status | String | Enabled |
The status of the advertised BGP network. |
VpcId | String | vpc-bp1qpo0kug3a2***** |
The ID of the virtual private cloud (VPC). |
DstCidrBlock | String | 10.1.XX.XX/24 |
The CIDR block of the advertised BGP network. |
RouterId | String | vrt-bp1lhl0taikrteen8**** |
The ID of the VBR. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeBgpNetworks
&RouterId=vrt-bp1lhl0taikrteen8****
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeBgpNetworksResponse>
<PageSize>10</PageSize>
<RequestId>6F513A15-669F-419D-B511-08A85292059B</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<BgpNetworks>
<Status>Enabled</Status>
<VpcId>vpc-bp1qpo0kug3a2*****</VpcId>
<DstCidrBlock>10.1.XX.XX/24</DstCidrBlock>
<RouterId>vrt-bp1lhl0taikrteen8****</RouterId>
</BgpNetworks>
</DescribeBgpNetworksResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 10,
"RequestId" : "6F513A15-669F-419D-B511-08A85292059B",
"PageNumber" : 1,
"TotalCount" : 2,
"BgpNetworks" : [ {
"Status" : "Enabled",
"VpcId" : "vpc-bp1qpo0kug3a2*****",
"DstCidrBlock" : "10.1.XX.XX/24",
"RouterId" : "vrt-bp1lhl0taikrteen8****"
} ]
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | The error message returned because the specified region ID does not exist. |
500 | InternalError | The request processing has failed due to some unknown error. | The error message returned because some unknown errors occurred. |
For a list of error codes, visit the API Error Center.