Add BGP Peer to BGP Group via CreateBgpPeer for Dynamic Routing - Express Connect - Alibaba Cloud - Express Connect

Calls the CreateBgpPeer API to add a BGP peer to the specified BGP group.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:CreateBgpPeer

create

*VirtualBorderRouter

acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the BGP group. You can call the DescribeRegions API to obtain the region ID.	cn-shanghai
BgpGroupId	string	Yes	The ID of the BGP group.	bgpg-wz9f62v4fbg****
PeerIpAddress	string	No	The IP address of the BGP peer.	116.62.XX.XX
EnableBfd	boolean	No	Specifies whether to enable Bidirectional Forwarding Detection (BFD). Valid values: true: enables BFD. false: disables BFD.	true
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The client generates the value of this parameter. Make sure that the value is unique among different requests. The maximum length is 64 ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.	123e4567-e89b-12d3-a456-426655440000
IpVersion	string	No	The IP version. Valid values: IPv4 (default): IPv4. IPv6: IPv6. IPv6 is supported only when the VBR on which the BGP group is created has IPv6 enabled.	IPv4
BfdMultiHop	integer	No	The BFD hop count. Valid values: 1 to 255. This parameter is required when BFD is enabled. Specify the BFD hop count, which is the maximum number of devices that data passes through from the source to the destination. You can configure different hop counts based on actual physical link factors. Note When you use BFD in a multi-cloud environment or a fiber direct connect network without any bridging devices in between, you need to change the default BFD hop count from 255 to 1.	3

Response elements

Element	Type	Description	Example
	object
BgpPeerId	string	The ID of the BGP peer.	bgp-m5eoyp2mwegk8ce9v****
RequestId	string	The request ID.	D4B7649A-61BB-4C64-A586-1DFF1EDA6A42

Examples

Success response

JSON format

{
  "BgpPeerId": "bgp-m5eoyp2mwegk8ce9v****",
  "RequestId": "D4B7649A-61BB-4C64-A586-1DFF1EDA6A42"
}

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	InvalidAccessDeviceId.NotFound	There is no Access_Device_Id in our records
400	QuotaExceeded.BfdSession	Your Bfd Session number reaches the upper limit.
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	InvalidBgpDiscription.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	invalid peer asn cannot equals aliyun asn:45104
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	BgpPeer.Already.Exists	bgp peer already exists.
400	MissingParam.EnableBfd	The parameter EnableBfd is missing.
400	OperationUnsupported.IPV6ForThisRegion	This Region is unsupported IPV6.
400	IllegalParam.BfdMultiHop	BfdMultiHop is illegal.
400	OperationFailed.PconnTrafficNotEnable	The operation is failed because of PconnTrafficNotEnable.	Billing for outbound data transfer is disabled.
400	UnsupportedFeature.Vpconn	The feature of Vpconn is not supported.	The Express Connect circuit type is not supported.
400	DuplicatedParam.PeerIpAddress	The param of PeerIpAddress is duplicated.	Duplicate IP addresses of BGP peers exist.
400	DuplicatedParam.LocalIpAddress	The LocalIpAddress already exists.	The error message returned because you specified a duplicate local IP address. Change the local IP address and try again.
400	DuplicatedParam.PeerIpv6Address	The PeerIpv6Address already exists.	The error message returned because you specified a duplicate peer IP address. Change the peer IP address and try again.
400	DuplicatedParam.LocalIpv6Address	The LocalIpv6Address already exists.	The error message returned because you specified a duplicate local IP address. Change the local IP address and try again.
400	IllegalParam.LocalGatewayIpAndMask	The LocalGatewayIpAndMask value is invalid.	The error message returned because the IP address of the local gateway and the subnet mask are invalid. Specify a valid IP address and subnet mask and try again.
400	IllegalParam.PeeringIpv6SubnetMask	The PeeringIpv6SubnetMask value is invalid.	The error message returned because the subnet mask is invalid. Specify a valid subnet mask and try again.
400	IllegalParam.IpVersion	The param of IPV6 is illegal.	The parameter IpVersion is abnormal. Please check the parameter and try again.
400	IllegalParam.PeerIpAddress	The param of PeerIpAddress is illegal.	The peer IP address is invalid.
404	InvalidRegionId.NotFound	Specified value of "regionId" is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.