Queries Border Gateway Protocol (BGP) groups in a region.


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.

RegionId String Yes cn-shanghai

The ID of the region where the BGP group is deployed.

You can call the DescribeRegions operation to query region IDs.

RouterId String No vrt-kojok19x3j0q6kx

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

BgpGroupId String No bgpg-wz9f62v4fbg2gxxxxxxxx

The ID of the BGP group.

IsDefault Boolean No false

Specifies whether the specified BGP group is the default one.

PageNumber Integer No 1

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

PageSize Integer No 1

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

Response parameters

Parameter Type Example Description
RequestId String 1D0971B2-A35A-42C1-A44C-E91360C36C0B

The ID of the request.

TotalCount Integer 10

The total number of entries.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 5

The number of entries returned per page.

BgpGroups Array

The detailed information about the BGP group.

Name String Name

The name of the BGP group.

Description String Description

The description of the BGP group.

BgpGroupId String bgp-wz977wcrmb69axxxxxxxx

The ID of the BGP group.

PeerAsn String 1111

The autonomous system (AS) number of the BGP peer.

AuthKey String ! PWZ2wsq

The key used by the BGP group.

RouterId String vrt-bp1lhl0taikrteen*****

The ID of the VBR.

Status String active

The state of the BGP peer.

Keepalive String 10

The keepalive time.

LocalAsn String 45104

The local AS number.

Hold String 30

The hold time to receive BGP messages. If no message is received within the hold time, the BGP peer is considered disconnected.

IsFake String true

Indicates whether the AS number is fake.

RouteLimit String 99

Routing limits.

RegionId String cn-shanghai

The ID of the region where the BGP group is deployed. For more information about region IDs, see Regions and zones.


Sample requests

http(s)://[Endpoint]/? Action=DescribeBgpGroups
&<Common request parameters>

Sample success responses

XML format


JSON format

    "TotalCount": 1, 
    "PageSize": 10, 
    "RequestId": "09E2C0FD-37FF-4737-80DF-517AC36D43DB", 
    "BgpGroups": {
        "BgpGroup": [
                "BgpGroupId": "bgpg-2zev8h2wo******", 
                "LocalAsn": 45104, 
                "Hold": 30, 
                "Description": "", 
                "AuthKey": "", 
                "IsFake": true, 
                "PeerAsn": 234, 
                "Keepalive": 10, 
                "RouteLimit": 99, 
                "Name": "Group1", 
                "Status": "Pending", 
                "RouterId": "vbr-2zecmmvg5gvu8i4*****", 
                "RegionId": "cn-beijing"

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 unknown errors have 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. Check whether the service is available in the region.

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