Create BGP Group on VBR Using CreateBgpGroup API - Express Connect - Alibaba Cloud - Express Connect

Creates a BGP group for a virtual border router (VBR).

Operation description

You can connect a VBR to a data center through BGP. Each BGP group is associated with a VBR. You can add BGP peers that communicate with the VBR to a BGP group and advertise the BGP network in the VBR.

BGP groups simplify BGP configurations by letting you group BGP peers that share the same settings. Before you start, create a BGP group with the required autonomous system number (ASN).

When you call this operation, note the following limits:

You can specify only the data center that is connected to the VBR through an Express Connect circuit as a BGP peer.
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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VBR. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
RouterId	string	Yes	The ID of the VBR.	vbr-bp1ctxy813985gkuk****
Name	string	No	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 (-). The name must start with a letter.	test
Description	string	No	The description of the BGP group. The description must be 2 to 256 characters in length. It must start with a letter and cannot start with `http://` or `https://`.	BGP
LocalAsn	integer	No	The custom ASN on the Alibaba Cloud side. Valid values: 45104 64512~65534 4200000000~4294967294 Note 65025 is reserved by Alibaba Cloud. By default, Alibaba Cloud uses 45104 as LocalAsn. If you use custom LocalAsn in multi-line access scenarios, loops in BGP may occur.	45104
PeerAsn	integer	Yes	The ASN of the gateway device in the data center.	1****
AuthKey	string	No	The authentication key of the BGP group.	!PWZ2****
IsFakeAsn	boolean	No	Whether to use a fake ASN. Valid values: false (default) true Note A router that runs BGP typically belongs to only one AS. If you need to replace an existing AS with a new AS and you cannot immediately modify BGP configurations, you can use fake ASNs to ensure service continuity.	true
ClientToken	string	No	The client token that ensures the idempotence of the request. You can use the client to generate the token, but you must ensure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
IpVersion	string	No	The IP version. Valid values: IPv4: This is the default value. IPv6: IPv6 is supported only if the VBR has IPv6 enabled.	IPv4
RouteQuota	integer	No	The maximum number of routes supported by a BGP peer. Default value: 110.	110

Response elements

Element	Type	Description	Example
	object	The ID of the BGP group.
BgpGroupId	string	The ID of the BGP group.	bgpg-bp1k25cyp26cllath****
RequestId	string	The request ID.	C1221A1F-2ACD-4592-8F27-474E02883159

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	QuotaExceeded.Bgp	bgp peer count per vbr quota exceed.	The number of BGP peers in the VBR has reached the upper limit.
400	QuotaExceeded.Nqa	nqa count per vbr quota exceed.
400	QuotaExceeded.BgpNetwork	bgp network count per vbr quota exceed.
400	InvalidPeerIpAddress	multi pconn peer ip can not be null.
400	InvalidVbrNetwork	vbr netowrk not exists
400	InvalidBgpGroup	bgp group not exists
400	InvalidBgpName.Malformed	Specified Bgp Group name is not valid.
400	InvalidBgpDescription.Malformed	Specified Bgp Group description is not valid.
400	InvalidBgpAuthkey.Malformed	Specified Bgp Group authkey is not valid.
400	InvalidIP.Malformed	Ip malformed.
400	InvalidPeerAsn.Malformed	invalid peer asn cannot equals aliyun asn:45104
400	InvalidParams.NotNull	params must not null.	The parameter is required.
400	InvalidBgpGroup.LocalAsnInvalid	The specified BgpGroup LocalAsn is invalid, only support 64512 to 65534 or 4200000000 to 4294967294, but cannot be 65025.	The local ASN of the BGP group is invalid. You must set a value from 64512 to 65534 or from 420000000 to 429496729.
400	InvalidParams.NotFound	instance not found
400	InvalidParams.AlreadyExists	bgp network already exists	The BGP network already exists.
400	InvalidStatus.CannotOperate	invalid status cannot operate
400	InvalidParams.PeerIpAddressMustPointOut	vbr has 0 or more than 1 subif ,point out peerIpAddress.	You must set the PeerIpAddress parameter.
400	InvalidParams.PeerIpAddressInUse	peer ip address in use ,cannot create bgp peer.	The peer IP address is being used. Therefore, you cannot use it to create a BGP peer.
400	IllegalParam.PeerAsn	The param of PeerAsn is illegal	The PeerAsn parameter is set to an invalid value.
400	IllegalParam.LocalAsn	The param of LocalAsn is illegal	The LocalAsn parameter is set to an invalid value.
400	OperationFailed.PconnTrafficNotEnable	The operation is failed because of PconnTrafficNotEnable.	Billing for outbound data transfer is disabled.
400	OperationUnsupport	Operation is unsupport, not in vbr support custom local asn white list.	The operation is not supported.
400	IllegalParam.RouteLimit	The operation is failed because of bgp group max route entry num quota exceed.	The number of routes that can be received by each BGP peer in the BGP group exceeds the upper limit.
400	IllegalParam.BgpGroupLocalAsn	VBR BgpGroup localAsn must same with ECR asn.	The LocalAsn of the VBR must be the same as the ASN of the ECR.
400	OperationDenied.VbrAttachEcrInMiddleStatus	The operation is not allowed because of VBR attach or detach ECR in middle status.	The current operation cannot be performed because the VBR is in the process of loading or unloading the leased line gateway. Please wait a moment and try again.
400	OperationFailed.BgpPeerConflictWithECR	The BGP neighbor created by the previous VBR conflicts with the ECR configuration.	The BGP neighbor created by the current VBR conflicts with the ECR configuration. Delete the BGP configuration and try again.
400	OperationFailed.PeerAsnCannotEqualsLocalAsn	Peer ASN is illegal, peer ASN cannot equals to local ASN.	When adding a BGPGroup, the peer autonomous system number cannot be the same as the local autonomous system number. Please check the parameters and try again.
404	InvalidRegionId.NotFound	The specified RegionId is not found.	The specified region ID is invalid. Check whether the service is available in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.