Queries Border Gateway Protocol (BGP) groups.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBgpGroups

The operation that you want to perform. Set the value to DescribeBgpGroups.

RouterId String No vbr-bp1ctxy813985gkuk****

The ID of the virtual border router (VBR) that is associated with the BGP group.

BgpGroupId String No bgpg-bp1k25cyp26cllath****

The ID of the BGP group.

RegionId String Yes cn-shanghai

The region ID of the VBR.

You can call the DescribeRegions operation to query the most recent region list.

IsDefault Boolean No false

Specifies whether the BGP group is the default one. Valid values:

  • false: yes
  • true: no
PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String 1D0971B2-A35A-42C1-A44C-E91360C36C0B

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The number of entries returned.

BgpGroups Array of BgpGroup

The detailed information about the BGP group.

Status String Available

The status of the BGP group.

BgpGroupId String bgpg-bp1k25cyp26cllath****

The ID of the BGP group.

RouterId String vbr-bp1ctxy813985gkuk****

The ID of the VBR.

PeerAsn String 1****

The autonomous system number (ASN) of the gateway device in the data center.

LocalAsn String 45104

The ASN of the VBR.

RegionId String cn-shanghai

The ID of the region to which the BGP group belongs.

Hold String 30

The hold time to receive BGP messages. Unit: seconds.

Note If no message is received within the hold time, the BGP peer is considered disconnected.
IpVersion String IPv4

The IP version of the BGP group. Valid values:

  • ipv4: IPv4
  • ipv6: IPv6. IPv6 is supported only if the VBR of the BGP group has IPv6 enabled.
Description String Description

The description of the BGP group.

Keepalive String 10

The keepalive time. Unit: seconds.

IsFake String true

Indicates whether the ASN is fake. Valid values:

  • false: no
  • true: yes
RouteLimit String 99

The maximum number of route entries for BGP dynamic route learning.

Name String name

The name of the BGP group.

AuthKey String !PWZ****

The key used by the BGP group.


Sample requests

&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK

        <Description>Description </Description>

JSON format

HTTP/1.1 200 OK

  "PageSize" : 10,
  "RequestId" : "1D0971B2-A35A-42C1-A44C-E91360C36C0B",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "BgpGroups" : [ {
    "Status" : "Available",
    "BgpGroupId" : "bgpg-bp1k25cyp26cllath****",
    "RouterId" : "vbr-bp1ctxy813985gkuk****",
    "PeerAsn" : "1****",
    "LocalAsn" : "45104",
    "RegionId" : "cn-shanghai",
    "Hold" : "30",
    "IpVersion" : "ipv4",
    "Description" : "Description",
    "Keepalive" : "10",
    "IsFake" : "true",
    "RouteLimit" : "99",
    "Name" : "name",
    "AuthKey" : "!PWZ****"
  } ]

Error codes

HttpCode Error code Error message Description
500 InternalError The request processing has failed due to some unknown error. The error message returned because an unknown error occurred.
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the specified region ID does not exist.

For a list of error codes, visit the API Error Center.