DescribeBgpGroups - API reference| Alibaba Cloud Documentation Center

Description

Query the created BGP groups.

Request parameters

Name	Type	Required	Description
Action	String	Yes	The action to perform. Valid value: DescribeBgpGroups
RegionId	String	Yes	The region of the BGP group. You can obtain the region ID by calling the DescribeRegions API.
BgpGroupId	String	No	The ID of the BGP group.
RouterId	String	No	The ID of the VBR associated with the BGP group.
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.
BGPGroups	JSON string	The detailed information of queried BGP groups.
TotalCount	Integer	The number of queried entries.
PageNumber	Integer	The current page number.
PageSize	Integer	The number of entries on the current page.

Error codes

See VPC API Error Center.

Examples

Request example

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

Response example

XML format

<DescribeBgpGroupsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>08107C9E-2F15-4592-BD9A-C4B2E1550518</RequestId>
    <BgpGroups>
        <BgpGroup>
            <BgpGroupId>bgpg-2ze5yaac33qfqzo1omgxu</BgpGroupId>
            <LocalAsn>45104</LocalAsn>
            <Hold>30</Hold>
            <Description></Description>
            <AuthKey></AuthKey>
            <IsFake>true</IsFake>
            <PeerAsn>1231</PeerAsn>
            <Keepalive>10</Keepalive>
            <RouteLimit>99</RouteLimit>
            <Name></Name>
            <Status>Modifying</Status>
            <RouterId>vbr-2zeff11o2sqhnp1u7ci93</RouterId>
            <RegionId>cn-beijing</RegionId>
        </BgpGroup>
    </BgpGroups>
</DescribeBgpGroupsResponse>

JSON format

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "08107C9E-2F15-4592-BD9A-C4B2E1550518",
  "BgpGroups": {
    "BgpGroup": [
      {
        "BgpGroupId": "bgpg-2ze5yaac33qfqzo1omgxu",
        "LocalAsn": 45104,
        "Hold": 30,
        "Description": "",
        "AuthKey": "",
        "IsFake": true,
        "PeerAsn": 1231,
        "Keepalive": 10,
        "RouteLimit": 99,
        "Name": "",
        "Status": "Modifying",
        "RouterId": "vbr-2zeff11o2sqhnp1u7ci93",
        "RegionId": "cn-beijing"
      }
    ]
  }
}