DescribeBgpPeers - Express Connect - Alibaba Cloud Documentation Center

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

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

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 peer that you want to query.	vbr-2zecmmvg5gvu8i4te****
BgpPeerId	string	No	The ID of the BGP peer that you want to query.	bgp-2ze3un0ft1jd1xd****
BgpGroupId	string	No	The ID of the BGP group to which the BGP peer that you want to query belongs.	bgpg-2zev8h2wo414sfh****
RegionId	string	Yes	The region ID of the BGP group to which the BGP peer that you want to query belongs. You can call the DescribeRegions operation to obtain the region ID.	cn-shanghai
IsDefault	boolean	No	Specifies whether the BGP group is the default group. Valid values: true false	false
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The information about the BGP peer.
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumber	integer	The page number.	1
TotalCount	integer	The number of entries returned.	10
BgpPeers	array<object>	The information about the BGP peer.
BgpPeer	object
Status	string	The status of the BGP peer. Valid values: Pending Available Modifying Deleting Deleted	Available
PeerIpAddress	string	The IP address of the BGP peer.	116.62.XX.XX
RouterId	string	The Router ID.	vbr-2zecmmvg5gvu8i4te****
BgpGroupId	string	The ID of the BGP group.	bgpg-2zev8h2wo414sfh****
BgpStatus	string	The status of the BGP connection. Valid values: Idle: The BGP connection is not used. Connect: The BGP connection is used. Active: The BGP connection is available. Established: The BGP connection is established. Down: The BGP connection is unavailable.	Connect
BfdMultiHop	integer	The Bidirectional Forwarding Detection (BFD) hop count.	3
PeerAsn	string	The autonomous system number (ASN)of the BGP peer.	65515
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
BgpPeerId	string	The ID of the BGP peer.	bgp-2ze3un0ft1jd1xd****
EnableBfd	boolean	Indicates whether BFD is enabled. Valid values: true false	true
Hold	string	The hold time.	30
IpVersion	string	The version of the IP address.	ipv4
Keepalive	string	The Keepalive interval.	10
Description	string	The description of the BGP group.	test
RouteLimit	string	The maximum number of routes.	110
IsFake	boolean	Indicates whether a fake autonomous system number (ASN) is used. Valid values: true false	true
AuthKey	string	The authentication key of the BGP group.	!PWZ****
Name	string	The name of the BGP peer.	test
AdvertisedRouteCount	integer	The number of advertised routes.	0
ReceivedRouteCount	integer	The number of received routes.	0
GmtModified	string	The time when the BGP peer is modified.	2022-05-20T07:29:08Z

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber": 1,
  "TotalCount": 10,
  "BgpPeers": {
    "BgpPeer": [
      {
        "Status": "Available",
        "PeerIpAddress": "116.62.XX.XX",
        "RouterId": "vbr-2zecmmvg5gvu8i4te****",
        "BgpGroupId": "bgpg-2zev8h2wo414sfh****",
        "BgpStatus": "Connect",
        "BfdMultiHop": 3,
        "PeerAsn": "65515",
        "LocalAsn": "45104",
        "RegionId": "cn-shanghai",
        "BgpPeerId": "bgp-2ze3un0ft1jd1xd****",
        "EnableBfd": true,
        "Hold": "30",
        "IpVersion": "ipv4",
        "Keepalive": "10",
        "Description": "test",
        "RouteLimit": "110",
        "IsFake": true,
        "AuthKey": "!PWZ****",
        "Name": "test",
        "AdvertisedRouteCount": 0,
        "ReceivedRouteCount": 0,
        "GmtModified": "2022-05-20T07:29:08Z"
      }
    ]
  }
}

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.

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

Change history

Change time	Summary of changes	Operation
2024-05-08	The Error code has changed	View Change Details
2023-09-11	API Description Update. The Error code has changed	View Change Details
2021-11-17	The Error code has changed. The response structure of the API has changed	View Change Details