DescribeBgpPeers - API reference| Alibaba Cloud Documentation Center

Debug

By using API Explorer, you can easily debug APIs, automatically generate SDK code examples, and quickly search for APIs.

Request parameters


Parameter	Type	Required?	Example value	Description
Action	String	Yes	DescribeBgpPeers	The name of this action. Value: DescribeBgpPeers
RegionId	String	Yes	cn-shanghai	The region to which the BGP peer belongs. To query the region ID, call DescribeRegions.
BgpGroupId	String	No	bgpg-2zev8h2wo414sfhjgdlhh	The ID of the BGP group.
BgpPeerId	String	No	bgp-2ze3un0ft1jd1xdppusul	The ID of the BGP peer.
IsDefault	Boolean	No	false	Indicates whether the specified BGP group is the default BGP group.
OwnerAccount	String	No	xxx@aliyun.com	The owner account.
PageNumber	Integer	No	1	The number of pages to return. Default value: 1.
PageSize	Integer	No	1	The number of rows per page. Maximum value: 50. Default value: 10.
RouterId	String	No	vrt-acfmxazb4ph6aiy	The ID of the VBR.

Response parameters


Parameter	Type	Example value	Description
BgpPeers	N/A	N/A	A list of BGP peers.
└Name	String	test	The name of the BGP peer.
└PeerIpAddress	String	116.62.222.28	The IP address of the BGP peer.
└AuthKey	String	!PWZ2wsq	The authentication key of the BGP group.
└RouterId	String	vbr-2zecmmvg5gvu8i4telkhw	The ID of the router.
└Status	String	active	The status of the BGP peer.
└BgpGroupId	String	bgp-wz977wcrmb69axxxxxxxx	The ID of the BGP group.
└BgpPeerId	String	bgp-wz977wcrmb69agdbab8s1	The ID of the BGP peer.
└BgpStatus	String	Established	The connection status of the BGP.
└Description	String	xxxxxxxxx	The description of the BGP group.
└Hold	String	30	The hold time.
└IsFake	String	true	Indicates whether a fake ASN is enabled.
└Keepalive	String	10	The keep-alive time.
└LocalAsn	String	45104	The local ASN.
└PeerAsn	String	active	The ASN of the BGP peer.
└RegionId	String	cn-shanghai	The ID of the region to which the BGP group belongs.
└RouteLimit	String	99	The route quota.
TotalCount	Integer	10	The number of queried entries.
PageNumber	Integer	1	The current page number.
PageSize	Integer	2	The number of entries per page.
RequestId	String	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6	The ID of the request.

Examples

Request example


https://vpc.aliyuncs.com/?Action=DescribeBgpPeers
&RegionId=cn-shanghai
&<CommonParameters>

Response example

XML format

<<?xml version="1.0" encoding="UTF-8" ?>
<DescribeBgpGroupsResponse>
	<TotalCount>2</TotalCount>
	<PageSize>10</PageSize>
	<RequestId>16DFA5E6-9771-41B7-B079-DD7C2DF49BE6</RequestId>
	<BgpPeers>
		<BgpPeer>
			<BgpGroupId>bgpg-2zev8h2wo414sfhjgdlhh</BgpGroupId>
			<LocalAsn>45104</LocalAsn>
			<PeerIpAddress>11.11.11.1</PeerIpAddress>
			<Hold>30</Hold>
			<Description></Description>
			<AuthKey></AuthKey>
			<IsFake>true</IsFake>
			<PeerAsn>234</PeerAsn>
			<Keepalive>10</Keepalive>
			<RouteLimit>99</RouteLimit>
			<BgpPeerId>bgp-2ze3un0ft1jd1xdppusul</BgpPeerId>
			<Name></Name>
			<Status>Available</Status>
			<BgpStatus></BgpStatus>
			<RouterId>vbr-2zecmmvg5gvu8i4telkhw</RouterId>
			<RegionId>cn-beijing</RegionId>
		</BgpPeer>
		<BgpPeer>
			<BgpGroupId>bgpg-2zev8h2wo414sfhjgdlhh</BgpGroupId>
			<LocalAsn>45104</LocalAsn>
			<PeerIpAddress>11.11.11.2</PeerIpAddress>
			<Hold>30</Hold>
			<Description></Description>
			<AuthKey></AuthKey>
			<IsFake>true</IsFake>
			<PeerAsn>234</PeerAsn>
			<Keepalive>10</Keepalive>
			<RouteLimit>99</RouteLimit>
			<BgpPeerId>bgp-2zeu54rbreqqzyb5bg1hq</BgpPeerId>
			<Name></Name>
			<Status>Available</Status>
			<BgpStatus></BgpStatus>
			<RouterId>vbr-2zecmmvg5gvu8i4telkhw</RouterId>
			<RegionId>cn-beijing</RegionId>
		</BgpPeer>
	</BgpPeers>
</DescribeBgpGroupsResponse>

JSON format

{
	"TotalCount":2,
	"PageSize":10,
	"RequestId":"16DFA5E6-9771-41B7-B079-DD7C2DF49BE6",
	"BgpPeers":{
		"BgpPeer":[
			{
				"BgpGroupId":"bgpg-2zev8h2wo414sfhjgdlhh",
				"LocalAsn":45104,
				"PeerIpAddress":"11.11.11.1",
				"Hold":30,
				"Description":"",
				"AuthKey":"",
				"IsFake":true,
				"PeerAsn":234,
				"Keepalive":10,
				"RouteLimit":99,
				"BgpPeerId":"bgp-2ze3un0ft1jd1xdppusul",
				"Name":"",
				"Status":"Available",
				"BgpStatus":"",
				"RouterId":"vbr-2zecmmvg5gvu8i4telkhw",
				"RegionId":"cn-beijing"
			},
			{
				"BgpGroupId":"bgpg-2zev8h2wo414sfhjgdlhh",
				"LocalAsn":45104,
				"PeerIpAddress":"11.11.11.2",
				"Hold":30,
				"Description":"",
				"AuthKey":"",
				"IsFake":true,
				"PeerAsn":234,
				"Keepalive":10,
				"RouteLimit":99,
				"BgpPeerId":"bgp-2zeu54rbreqqzyb5bg1hq",
				"Name":"",
				"Status":"Available",
				"BgpStatus":"",
				"RouterId":"vbr-2zecmmvg5gvu8i4telkhw",
				"RegionId":"cn-beijing"
			}
		]
	}
}

Error codes


HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.	An error occurred while the request was being processed.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified region ID does not exist.

See common error codes