edit-icon download-icon

DescribeBgpGroups

Last Updated: Apr 09, 2018

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.

BgpGroupIdStringNoThe ID of the BGP group.
RouterIdStringNoThe ID of the VBR associated with the BGP group.
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.
BGPGroups JSON string The detailed information of queried BGP groups.
TotalCountIntegerThe number of queried entries.
PageNumberIntegerThe current page number.
PageSizeIntegerThe number of entries on the current page.

Error codes

See VPC API Error Center.

Examples

Request example

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

Response example

XML format

  1. <DescribeBgpGroupsResponse>
  2. <TotalCount>1</TotalCount>
  3. <PageSize>10</PageSize>
  4. <RequestId>08107C9E-2F15-4592-BD9A-C4B2E1550518</RequestId>
  5. <BgpGroups>
  6. <BgpGroup>
  7. <BgpGroupId>bgpg-2ze5yaac33qfqzo1omgxu</BgpGroupId>
  8. <LocalAsn>45104</LocalAsn>
  9. <Hold>30</Hold>
  10. <Description></Description>
  11. <AuthKey></AuthKey>
  12. <IsFake>true</IsFake>
  13. <PeerAsn>1231</PeerAsn>
  14. <Keepalive>10</Keepalive>
  15. <RouteLimit>99</RouteLimit>
  16. <Name></Name>
  17. <Status>Modifying</Status>
  18. <RouterId>vbr-2zeff11o2sqhnp1u7ci93</RouterId>
  19. <RegionId>cn-beijing</RegionId>
  20. </BgpGroup>
  21. </BgpGroups>
  22. </DescribeBgpGroupsResponse>

JSON format

  1. {
  2. "TotalCount": 1,
  3. "PageSize": 10,
  4. "RequestId": "08107C9E-2F15-4592-BD9A-C4B2E1550518",
  5. "BgpGroups": {
  6. "BgpGroup": [
  7. {
  8. "BgpGroupId": "bgpg-2ze5yaac33qfqzo1omgxu",
  9. "LocalAsn": 45104,
  10. "Hold": 30,
  11. "Description": "",
  12. "AuthKey": "",
  13. "IsFake": true,
  14. "PeerAsn": 1231,
  15. "Keepalive": 10,
  16. "RouteLimit": 99,
  17. "Name": "",
  18. "Status": "Modifying",
  19. "RouterId": "vbr-2zeff11o2sqhnp1u7ci93",
  20. "RegionId": "cn-beijing"
  21. }
  22. ]
  23. }
  24. }
Thank you! We've received your feedback.