Creates a Border Gateway Protocol (BGP) group for a specified virtual border router (VBR).

Usage notes

You can use BGP to connect a VBR to a data center. Each BGP group is associated with a VBR. You can add a BGP peer that needs to communicate with a VBR to the corresponding BGP group and advertise the BGP network in the VBR.

BGP groups are used to simplify BGP configurations. You can save time and effort by adding BGP peers that use the same configurations to one BGP group. Before you start, you must create a BGP group with the requested autonomous system number (ASN).

When you call this operation, take note of the following limits:

  • You can specify only the data center as the BGP peer of a VBR.
  • VBRs support only BGP-4.
  • You can create at most eight BGP peers for each VBR.
  • Each BGP peer supports at most 110 dynamic routes.
  • The ASN of Alibaba Cloud is 45104. You can specify a 2-byte or 4-byte ASN for the data center.
  • Bidirectional Forwarding Detection (BFD) is disabled for VBRs by default. To use this feature, contact Alibaba Cloud.

Debugging

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 CreateBgpGroup

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

RegionId String Yes cn-shanghai

The region ID of the VBR.

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

RouterId String Yes vbr-bp1ctxy813985gkuk****

The ID of the VBR.

Name String No test

The name of the BGP group. The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. It cannot start with http:// or https://.

Description String No BGP

The description of the BGP group. The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with http:// or https://.

LocalAsn Long No 45104

The ASN of the VBR.

PeerAsn Long Yes 1****

The ASN of the gateway device in the data center.

AuthKey String No !PWZ2****

The authentication key of the BGP group.

IsFakeAsn Boolean No true

Specifies whether to use a fake ASN. Valid values:

  • false (default): no
  • true: yes
Note A running BGP router typically belongs to only one AS. If you want to replace the current AS with a new one (for example, the current AS needs to be migrated or merged with another one) and you cannot modify BGP configurations, you can specify a fake AS number to establish connections to the on-premises device. This ensures that your services are not interrupted.
ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
IpVersion String No IPv4

The IP version. Valid values:

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

Response parameters

Parameter Type Example Description
BgpGroupId String bgpg-bp1k25cyp26cllath****

The ID of the BGP group.

RequestId String C1221A1F-2ACD-4592-8F27-474E02883159

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBgpGroup
&RegionId=cn-shanghai
&RouterId=vbr-bp1ctxy813985gkuk****
&Name=test
&Description=BGP
&LocalAsn=45104
&AuthKey=!PWZ2****
&IsFakeAsn=true
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&IpVersion=IPv4
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateBgpGroupResponse>
    <BgpGroupId>bgpg-bp1k25cyp26cllath****</BgpGroupId>
    <RequestId>C1221A1F-2ACD-4592-8F27-474E02883159</RequestId>
</CreateBgpGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "BgpGroupId" : "bgpg-bp1k25cyp26cllath****",
  "RequestId" : "C1221A1F-2ACD-4592-8F27-474E02883159"
}

Error codes

HttpCode Error code Error message Description
400 QuotaExceeded.Bgp bgp peer count per vbr quota exceed. The error message returned because the number of BGP groups in the VBR has reached the upper limit.
400 QuotaExceeded.Nqa nqa count per vbr quota exceed. The error message returned because the Network Quality Analyzer (NQA) number has reached the upper limit.
400 QuotaExceeded.BgpNetwork bgp network count per vbr quota exceed. The error message returned because the number of BGP networks in the VBR has reached the upper limit.
400 InvalidPeerIpAddress multi pconn peer ip can not be null. The error message returned because the IP addresses of multiple Express Connect circuits cannot be empty.
400 InvalidVbrNetwork vbr netowrk not exists The error message returned because the specified VBR does not exist. Check whether the specified VBR is valid.
400 InvalidBgpGroup bgp group not exists The error message returned because the BGP group does not exist.
400 InvalidBgpName.Malformed Specified Bgp Group name is not valid. The error message returned because the name of the BGP group is invalid.
400 InvalidBgpDescription.Malformed Specified Bgp Group description is not valid. The error message returned because the description of the BGP group is invalid.
400 InvalidBgpAuthkey.Malformed Specified Bgp Group authkey is not valid. The error message returned because the authentication key of the BGP group is invalid.
400 InvalidIP.Malformed Ip malformed. The error message returned because the format of the IP address is invalid.
400 InvalidPeerAsn.Malformed invalid peer asn cannot equals aliyun asn:45104 The error message returned because the AS number cannot be the same as the AS number on the Alibaba Cloud side.
400 InvalidParams.NotFound instance not found The error message returned because the specified instance does not exist.
400 InvalidParams.NotFound vpc instance not found The error message returned because the specified virtual private cloud (VPC) does not exist. Check whether the specified VPC ID is valid.
400 InvalidParams.AlreadyExists bgp network already exists The error message returned because the BGP network already exists.
400 InvalidStatus.CannotOperate invalid status cannot operate The error message returned because you cannot perform the operation when the specified resource is in the current state.
400 QuotaExceeded.Bgp bgp group count per vbr quota exceed. The error message returned because the number of BGP groups in the virtual border router (VBR) has reached the upper limit.
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. The error message returned because billing for outbound data transfer is disabled.
404 InvalidRegionId.NotFound The specified RegionId is not found. The error message returned because the specified region ID is invalid. Check whether the service is available in the specified region.

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