edit-icon download-icon

DescribeBgpPeers

Last Updated: Apr 09, 2018

Description

Query the BGP peers in a region.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeBgpPeers

RegionId String Yes

The region of the BGP peer.

You can obtain the region ID by calling the DescribeRegions API.

BgpPeerIdStringNoThe ID of the BGP peer.
RouterIdStringNoThe ID of the VBR.
PageNumberIntegerNoThe number of pages to return. The default value is 1.
PageSizeIntegerNoThe number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
RequestId String The ID of the request.
BgpPeers JSON string The detailed information of queried BGP peers.
TotalCountIntegerThe number of queried entries.
PageNumberIntegerThe current page number.
PageSizeIntegerThe number of entries on the current page.
BgpPeers objects
BGPPeerId String The ID of the BGP peer.
NameStringThe name of the BGP peer.
LocalIpAddressStringThe IP address of the Alibaba Cloud side.
PeerIpAddressStringThe IP address of the BGP peer.
PeerASNIntegerThe ASN of the BGP peer.
AuthKeyStringThe key used by the BGP group.
BGPStatusStringThe connection status of the BGP.
RouterIdStringThe ID of the VBR.
StatusStringThe status of the BGP peer.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=DescribeBgpPeers
  2. &VRouterId=vrt-25u5f8u2q
  3. &<CommonParameters>

Response example

XML format

  1. <DescribeBgpPeersResponse>
  2. <TotalCount>1</TotalCount>
  3. <BgpPeers>
  4. <BgpPeer>
  5. <Status>Available</Status>
  6. <LocalAsn>45104</LocalAsn>
  7. <Description></Description>
  8. <BgpPeerId>bgp-2ze0dxfpp6fuw7gmzpaaa</BgpPeerId>
  9. <RegionId>cn-beijing</RegionId>
  10. <PeerIpAddress>11.11.11.11</PeerIpAddress>
  11. <IsFake>true</IsFake>
  12. <RouteLimit>99</RouteLimit>
  13. <PeerAsn>2010</PeerAsn>
  14. <AuthKey>888</AuthKey>
  15. <RouterId>vbr-2zeff11o2sqhnp1u7ci93</RouterId>
  16. <BgpGroupId>bgpg-2zeibi8idqnkhhgxgdcw9</BgpGroupId>
  17. <BgpStatus></BgpStatus>
  18. <Name></Name>
  19. <Hold>30</Hold>
  20. <Keepalive>10</Keepalive>
  21. </BgpPeer>
  22. </BgpPeers>
  23. <RequestId>3D6B3CB0-BEEE-4F30-8559-B3DA14AD705F</RequestId>
  24. <PageSize>10</PageSize>
  25. </DescribeBgpPeersResponse>

JSON format

  1. {
  2. "TotalCount": 1,
  3. "BgpPeers": {
  4. "BgpPeer": [
  5. {
  6. "Status": "Available",
  7. "LocalAsn": 45104,
  8. "Description": "",
  9. "BgpPeerId": "bgp-2ze0dxfpp6fuw7gmzpaaa",
  10. "RegionId": "cn-beijing",
  11. "PeerIpAddress": "11.11.11.11",
  12. "IsFake": true,
  13. "RouteLimit": 99,
  14. "PeerAsn": 2010,
  15. "AuthKey": "888",
  16. "RouterId": "vbr-2zeff11o2sqhnp1u7ci93",
  17. "BgpGroupId": "bgpg-2zeibi8idqnkhhgxgdcw9",
  18. "BgpStatus": "",
  19. "Name": "",
  20. "Hold": 30,
  21. "Keepalive": 10
  22. }
  23. ]
  24. },
  25. "RequestId": "3D6B3CB0-BEEE-4F30-8559-B3DA14AD705F",
  26. "PageSize": 10
  27. }
Thank you! We've received your feedback.