Advertise BGP Networks via AddBgpNetwork API - Express Connect - Alibaba Cloud - Express Connect

Invokes AddBgpNetwork to advertise a Border Gateway Protocol (BGP) network.

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:AddBgpNetwork

get

*VirtualBorderRouter

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the VBR group resides. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
DstCidrBlock	string	Yes	The CIDR block of the VPC or vSwitch that needs to be interconnected with the on-premises data center.	10.10.XX.XX/32
VpcId	string	No	The ID of the VPC.	vpc-bp1qpo0kug3a2*****
RouterId	string	Yes	The ID of the vRouter associated with the router interface.	vrt-2zeo3xzyf38r4u******
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only 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 may be different.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	9C7FA9D6-72E0-48A9-A9C3-2DA8569CD5EB

Examples

Success response

JSON format

{
  "RequestId": "9C7FA9D6-72E0-48A9-A9C3-2DA8569CD5EB"
}

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	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	parameter must not null.
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	Duplicated.CidrBlock	bgp network cidr already exists.
400	InvalidIP.IpInSnatPool	Multi ip in snat pool cannot remove ip from bandwidth package.
400	InvalidDestCidrBlock.Malformed	Specified dstCidrBlock is not valid.
400	IllegalParam.ConflictWithDClass	DClass IP can not support.
400	OperationFailed.PconnTrafficNotEnable	The operation is failed because of PconnTrafficNotEnable.	Billing for outbound data transfer is disabled.
400	OperationFailed.NoActiveRouterInterface	there's not active routerInterface,cannot add bgp network.
400	IllegalParamFormat.DstCidrBlock	The format of the specified destination CIDR block is invalid.	The error message returned because the format of the destination CIDR block is invalid.
400	IllegalParam.IpVersion	The parameter of IpVersion is illegal.
400	IllegalParam.ipVersion	The IP version does not match.	The operation failed because the IP version does not match.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.