Remove a BGP Peer from a VBR Using DeleteBgpPeer API - Express Connect - Alibaba Cloud - Express Connect

Calls DeleteBgpPeer to delete a specified BGP peer.

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

delete

*VirtualBorderRouter

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the BGP group is located. You can obtain the region ID by calling the DescribeRegions API.	cn-shanghai
BgpPeerId	string	Yes	The ID of the BGP peer.	bgp-wz977wcrmb69a********
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 only supports ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F

Examples

Success response

JSON format

{
  "RequestId": "611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F"
}

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	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	InvalidBgpPeer.NotFound	Bgp peer not found.
400	IncorrectStatus.BgpPeer	Invalid BgpPeer status cannot operate.	The status of the BGP peer does not support this operation.
400	OperationFailed.ResourceLockedBySystem	The specified resource is locked by system.	The operating resource is locked by the system and cannot be operated temporarily.
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.