DescribeBgpNetworks - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries advertised Border Gateway Protocol (BGP) networks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:DescribeBgpNetworks	get	VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RouterId	string	No	The ID of the VBR.	vrt-bp1lhl0taikrteen8****
RegionId	string	Yes	The region ID of the BGP group. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
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

Response parameters

Parameter	Type	Description	Example
	object	The number of entries per page.
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	6F513A15-669F-419D-B511-08A85292059B
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of advertised BGP networks.	2
BgpNetworks	array<object>	The BGP network.
BgpNetwork	object
Status	string	The status of the advertised BGP network.	Enabled
VpcId	string	The ID of the virtual private cloud (VPC) in which the master instance resides.	vpc-bp1qpo0kug3a2*****
DstCidrBlock	string	The CIDR block of the advertised BGP network.	10.1.XX.XX/24
RouterId	string	The ID of the VBR.	vrt-bp1lhl0taikrteen8****

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "6F513A15-669F-419D-B511-08A85292059B",
  "PageNumber": 1,
  "TotalCount": 2,
  "BgpNetworks": {
    "BgpNetwork": [
      {
        "Status": "Enabled",
        "VpcId": "vpc-bp1qpo0kug3a2*****",
        "DstCidrBlock": "10.1.XX.XX/24",
        "RouterId": "vrt-bp1lhl0taikrteen8****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified region ID does not exist.
500	InternalError	The request processing has failed due to some unknown error.	An unknown error occurred.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-11	API Description Update. The Error code has changed	View Change Details