All Products
Search
Document Center

Virtual Private Cloud:DescribeBgpGroups

Last Updated:Dec 02, 2023

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

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeBgpGroupsRead
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RouterIdstringNo

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

vbr-bp1ctxy813985gkuk****
BgpGroupIdstringNo

The ID of the BGP group.

bgpg-bp1k25cyp26cllath****
RegionIdstringYes

The ID of the region in which the VBR is deployed.

You can call the DescribeRegions operation to obtain the region ID.

cn-shanghai
IsDefaultbooleanNo

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

  • false
  • true
false
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. The maximum value is 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

1D0971B2-A35A-42C1-A44C-E91360C36C0B
PageNumberinteger

The page number.

1
TotalCountinteger

The number of entries returned.

1
BgpGroupsobject []

The detailed information about the BGP group.

Statusstring

The status of the BGP group.

Available
BgpGroupIdstring

The ID of the BGP group.

bgpg-bp1k25cyp26cllath****
RouterIdstring

The ID of the VBR.

vbr-bp1ctxy813985gkuk****
PeerAsnstring

The autonomous system number (ASN) of the on-premises device in the data center.

1****
LocalAsnstring

The ASN of the device on the Alibaba Cloud side.

45104
RegionIdstring

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

cn-shanghai
Holdstring

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.
30
IpVersionstring

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.
IPv4
Descriptionstring

The description of the BGP group.

Keepalivestring

The keepalive time. Unit: seconds.

10
IsFakestring

Indicates whether the ASN is fake. Valid values:

  • false
  • true
true
RouteLimitstring

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

99
Namestring

The name of the BGP group.

name
AuthKeystring

The key used by the BGP group.

!PWZ****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IellgalParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.-
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
500InternalErrorThe request processing has failed due to some unknown error.An unknown error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-11API Description Update,The error codes of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 500