调用CreateBgpPeer接口向指定的BGP组中添加BGP邻居。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateBgpPeer

系统规定参数。取值:CreateBgpPeer

RegionId String cn-shanghai

BGP组所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

BgpGroupId String bgpg-wz9f62v4fbg****

BGP组的ID。

PeerIpAddress String 116.62.XX.XX

BGP邻居的IP地址。

EnableBfd Boolean true

是否开启BFD功能,取值:

  • true:开启BFD功能。
  • false:不开启BFD功能。
ClientToken String 123e4567-e89b-12d3-a456-426655440000

客户端Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
IpVersion String ipv4

IP版本。

BfdMultiHop Integer 3

BFD跳数。取值范围:1~255

选择开启BFD功能时,需要配置此参数。

输入BFD跳数,即数据从源端到目标端传输时经过的最大设备数量。您可以根据真实的物理链路因素配置不同的跳数。

返回数据

名称 类型 示例值 描述
BgpPeerId String bgp-m5eoyp2mwegk8ce9v****

BGP邻居的ID。

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateBgpPeer
&RegionId=cn-shanghai
&BgpGroupId=bgpg-wz9f62v4fbg****
&PeerIpAddress=116.62.XX.XX
&EnableBfd=true
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&IpVersion=ipv4
&BfdMultiHop=3
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateBgpPeerResponse>
    <BgpPeerId>bgp-m5eoyp2mwegk8ce9v****</BgpPeerId>
    <RequestId>D4B7649A-61BB-4C64-A586-1DFF1EDA6A42</RequestId>
</CreateBgpPeerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 QuotaExceeded.Bgp bgp peer count per vbr quota exceed. 边界路由器的BGP组的数量已达到配额。
400 QuotaExceeded.Bgp bgp group count per vbr quota exceed. 边界路由器的BGP组的数量已达到配额。
400 QuotaExceeded.Nqa nqa count per vbr quota exceed. NQA数超过VBR配额。
400 QuotaExceeded.BgpNetwork bgp network count per vbr quota exceed. 边界路由器的BGP网络数量已达到配额。
400 InvalidPeerIpAddress multi pconn peer ip can not be null. 多物理专线的IP地址不能为空。
400 InvalidVbrNetwork vbr netowrk not exists 该边界路由器不存在,请您检查输入的边界路由器是否正确。
400 InvalidBgpGroup bgp group not exists 该BGP组不存在。
400 InvalidBgpName.Malformed Specified Bgp Group name is not valid. 该BGP组的名称不合法。
400 InvalidBgpDiscription.Malformed Specified Bgp Group description is not valid. 该BGP组的描述不合法。
400 InvalidBgpAuthkey.Malformed Specified Bgp Group authkey is not valid. 该BGP组的验证密钥不合法。
400 InvalidIP.Malformed Ip malformed. IP格式不合法。
400 InvalidPeerAsn.Malformed invalid peer asn cannot equals aliyun asn:45104 ASN号码不能和阿里云ASN号码一致。
400 InvalidParams.NotNull invalid peer asn cannot equals aliyun asn:45104 ASN号码不能和阿里云ASN号码一致。
400 InvalidParams.NotFound instance not found 实例不存在。
400 InvalidParams.NotFound vpc instance not found 该VPC不存在,请您检查输入的VPC是否正确。
400 InvalidParams.AlreadyExists bgp network already exists BGP网络已经存在。
400 InvalidStatus.CannotOperate invalid status cannot operate 状态不合法,无法执行该操作。
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. 操作失败,因为出方向流量未开通。
404 InvalidRegionId.NotFound Specified value of "regionId" is not supported. 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。

访问错误中心查看更多错误码。