DescribeBgpPeers - API reference| Alibaba Cloud Documentation Center

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.
BgpPeerId	String	No	The ID of the BGP peer.
RouterId	String	No	The ID of the VBR.
PageNumber	Integer	No	The number of pages to return. The default value is 1.
PageSize	Integer	No	The 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.
TotalCount	Integer	The number of queried entries.
PageNumber	Integer	The current page number.
PageSize	Integer	The number of entries on the current page.
`BgpPeers` objects
BGPPeerId	String	The ID of the BGP peer.
Name	String	The name of the BGP peer.
LocalIpAddress	String	The IP address of the Alibaba Cloud side.
PeerIpAddress	String	The IP address of the BGP peer.
PeerASN	Integer	The ASN of the BGP peer.
AuthKey	String	The key used by the BGP group.
BGPStatus	String	The connection status of the BGP.
RouterId	String	The ID of the VBR.
Status	String	The status of the BGP peer.

Error codes

See VPC API Error Center.

Examples

Request example

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

Response example

XML format

<DescribeBgpPeersResponse>
    <TotalCount>1</TotalCount>
    <BgpPeers>
        <BgpPeer>
            <Status>Available</Status>
            <LocalAsn>45104</LocalAsn>
            <Description></Description>
            <BgpPeerId>bgp-2ze0dxfpp6fuw7gmzpaaa</BgpPeerId>
            <RegionId>cn-beijing</RegionId>
            <PeerIpAddress>11.11.11.11</PeerIpAddress>
            <IsFake>true</IsFake>
            <RouteLimit>99</RouteLimit>
            <PeerAsn>2010</PeerAsn>
            <AuthKey>888</AuthKey>
            <RouterId>vbr-2zeff11o2sqhnp1u7ci93</RouterId>
            <BgpGroupId>bgpg-2zeibi8idqnkhhgxgdcw9</BgpGroupId>
            <BgpStatus></BgpStatus>
            <Name></Name>
            <Hold>30</Hold>
            <Keepalive>10</Keepalive>
        </BgpPeer>
    </BgpPeers>
    <RequestId>3D6B3CB0-BEEE-4F30-8559-B3DA14AD705F</RequestId>
    <PageSize>10</PageSize>
</DescribeBgpPeersResponse>

JSON format

{
  "TotalCount": 1,
  "BgpPeers": {
    "BgpPeer": [
      {
        "Status": "Available",
        "LocalAsn": 45104,
        "Description": "",
        "BgpPeerId": "bgp-2ze0dxfpp6fuw7gmzpaaa",
        "RegionId": "cn-beijing",
        "PeerIpAddress": "11.11.11.11",
        "IsFake": true,
        "RouteLimit": 99,
        "PeerAsn": 2010,
        "AuthKey": "888",
        "RouterId": "vbr-2zeff11o2sqhnp1u7ci93",
        "BgpGroupId": "bgpg-2zeibi8idqnkhhgxgdcw9",
        "BgpStatus": "",
        "Name": "",
        "Hold": 30,
        "Keepalive": 10
      }
    ]
  },
  "RequestId": "3D6B3CB0-BEEE-4F30-8559-B3DA14AD705F",
  "PageSize": 10
}