All Products
Search
Document Center

Virtual Private Cloud:CreateBgpPeer

Last Updated:Feb 21, 2024

Adds a Border Gateway Protocol (BGP) peer to a BGP group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:CreateBgpPeerWrite
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the BGP group belongs.

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

cn-shanghai
BgpGroupIdstringYes

The ID of the BGP group.

bgpg-wz9f62v4fbg****
PeerIpAddressstringNo

The IP address of the BGP peer.

116.62.XX.XX
EnableBfdbooleanNo

Specifies whether to enable the Bidirectional Forwarding Detection (BFD) feature. Valid values:

  • true: enables BFD.
  • false: disables BFD.
true
ClientTokenstringNo

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 the value 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 uses the value of RequestId as ClientToken. The value of RequestId for each API request is different.
123e4567-e89b-12d3-a456-426655440000
IpVersionstringNo

The IP version. Valid values:

  • IPv4: This is the default value.
  • IPv6: IPv6 is supported only if the VBR for which you want to create the BGP group has IPv6 enabled.
IPv4
BfdMultiHopintegerNo

The BFD hop count. Valid values: 1 to 255.

This parameter is required only if you enable BFD.

The parameter specifies the maximum number of network devices that a packet can traverse from the source to the destination. Set a value based on your network topology.

3

Response parameters

ParameterTypeDescriptionExample
object
BgpPeerIdstring

The ID of the BGP peer.

bgp-m5eoyp2mwegk8ce9v****
RequestIdstring

The ID of the request.

D4B7649A-61BB-4C64-A586-1DFF1EDA6A42

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400QuotaExceeded.Bgpbgp peer count per vbr quota exceed.The number of BGP peers in the VBR has reached the upper limit.
400QuotaExceeded.Bgpbgp group count per vbr quota exceed.The number of BGP groups in the VBR has reached the upper limit.
400QuotaExceeded.Nqanqa count per vbr quota exceed.The number of Network Quality Analyzers (NQAs) has reached the upper limit that is supported by the VBR.
400InvalidAccessDeviceId.NotFoundThere is no Access_Device_Id in our records-
400QuotaExceeded.BfdSessionYour Bfd Session number reaches the upper limit.-
400QuotaExceeded.BfdSessionThe Bfd Session on device reaches the upper limit.-
400QuotaExceeded.BgpNetworkbgp network count per vbr quota exceed.The number of BGP networks in the VBR has reached the upper limit.
400InvalidPeerIpAddressmulti pconn peer ip can not be null.The IP addresses of multiple Express Connect circuits cannot be empty.
400InvalidVbrNetworkvbr netowrk not existsThe VBR does not exist. Check the VBR ID.
400InvalidBgpGroupbgp group not existsThe BGP group does not exist.
400InvalidBgpName.MalformedSpecified Bgp Group name is not valid.The name of the BGP group is invalid.
400InvalidBgpDiscription.MalformedSpecified Bgp Group description is not valid.The description of the BGP group is invalid.
400InvalidBgpAuthkey.MalformedSpecified Bgp Group authkey is not valid.The authentication key of the BGP group is invalid.
400InvalidIP.MalformedIp malformed.The format of the IP address is invalid.
400InvalidPeerAsn.Malformedinvalid peer asn cannot equals aliyun asn:45104The AS number cannot be the same as the AS number on the Alibaba Cloud side.
400InvalidParams.NotNullinvalid peer asn cannot equals aliyun asn:45104The AS number cannot be the same as the AS number on the Alibaba Cloud side.
400InvalidParams.NotFoundinstance not foundThe specified instance does not exist.
400InvalidParams.NotFoundvpc instance not foundThe VPC does not exist. Check whether the specified VPC is valid.
400InvalidParams.AlreadyExistsbgp network already existsThe BGP network already exists.
400InvalidStatus.CannotOperateinvalid status cannot operateYou cannot perform the operation when the specified resource is in the current state.
400InvalidParams.PeerIpAddressMustPointOutvbr has 0 or more than 1 subif ,point out peerIpAddress.You must set the PeerIpAddress parameter.
400InvalidParams.PeerIpAddressInUsepeer 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.
400BgpPeer.Already.Existsbgp peer already exists.-
400MissingParam.EnableBfdThe parameter EnableBfd is missing.-
400OperationUnsupported.IPV6ForThisRegionThis Region is unsupported IPV6.-
400IllegalParam.BfdMultiHopBfdMultiHop is illegal.-
400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
400UnsupportedFeature.VpconnThe feature of Vpconn is not supported.The Express Connect circuit type is not supported.
400DuplicatedParam.PeerIpAddressThe param of PeerIpAddress is duplicated.Duplicate IP addresses of BGP peers exist.
400DuplicatedParam.LocalIpAddressThe LocalIpAddress already exists.The error message returned because you specified a duplicate local IP address. Change the local IP address and try again.
400DuplicatedParam.PeerIpv6AddressThe PeerIpv6Address already exists.The error message returned because you specified a duplicate peer IP address. Change the peer IP address and try again.
400DuplicatedParam.LocalIpv6AddressThe LocalIpv6Address already exists.The error message returned because you specified a duplicate local IP address. Change the local IP address and try again.
400IllegalParam.LocalGatewayIpAndMaskThe 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.
400IllegalParam.PeeringIpv6SubnetMaskThe PeeringIpv6SubnetMask value is invalid.The error message returned because the subnet mask is invalid. Specify a valid subnet mask and try again.
404InvalidRegionId.NotFoundSpecified value of "regionId" is not supported.RegionId is set to an invalid value. Check whether the service is available in the specified region and try again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-06-09The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404