DescribeBgpGroups - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries Border Gateway Protocol (BGP) groups in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RouterId	string	No	The ID of the virtual border router (VBR) that is associated with the BGP group.	vbr-bp1ctxy813985gkuk****
BgpGroupId	string	No	The ID of the BGP group.	bgpg-bp1k25cyp26cllath****
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
IsDefault	boolean	No	Specifies whether the BGP group is the default one. Valid values: false true	false
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. The maximum value is 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	1D0971B2-A35A-42C1-A44C-E91360C36C0B
PageNumber	integer	The page number.	1
TotalCount	integer	The number of entries returned.	1
BgpGroups	array<object>	The detailed information about the BGP group.
	object
Status	string	The status of the BGP group.	Available
BgpGroupId	string	The ID of the BGP group.	bgpg-bp1k25cyp26cllath****
RouterId	string	The ID of the VBR.	vbr-bp1ctxy813985gkuk****
PeerAsn	string	The autonomous system number (ASN) of the on-premises device in the data center.	1****
LocalAsn	string	The ASN of the device on the Alibaba Cloud side.	45104
RegionId	string	The ID of the region to which the BGP group belongs.	cn-shanghai
Hold	string	The hold time to receive BGP messages. Unit: seconds. Note If no message is received within the hold time, the BGP peer is considered disconnected.	30
IpVersion	string	The IP version of the BGP group. Valid values: ipv4: IPv4 ipv6: IPv6. IPv6 is supported only if the VBR of the BGP group has IPv6 enabled.	IPv4
Description	string	The description of the BGP group.	The description of the BGP group.
Keepalive	string	The keepalive time. Unit: seconds.	10
IsFake	string	Indicates whether the ASN is fake. Valid values: false true	true
RouteLimit	string	The maximum number of route entries for BGP dynamic route learning.	99
Name	string	The name of the BGP group.	name
AuthKey	string	The key used by the BGP group.	!PWZ****

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "1D0971B2-A35A-42C1-A44C-E91360C36C0B",
  "PageNumber": 1,
  "TotalCount": 1,
  "BgpGroups": {
    "BgpGroup": [
      {
        "Status": "Available",
        "BgpGroupId": "bgpg-bp1k25cyp26cllath****",
        "RouterId": "vbr-bp1ctxy813985gkuk****",
        "PeerAsn": "1****",
        "LocalAsn": "45104",
        "RegionId": "cn-shanghai",
        "Hold": "30",
        "IpVersion": "IPv4",
        "Description": "The description of the BGP group.",
        "Keepalive": "10",
        "IsFake": "true",
        "RouteLimit": "99",
        "Name": "name",
        "AuthKey": "!PWZ****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	-
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.

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