AI 助理
备案控制台
首页 专有网络VPC 开发参考 API参考 API目录 BGP CreateBgpPeer - 向指定的BGP组中添加BGP邻居

CreateBgpPeer - 向指定的BGP组中添加BGP邻居

更新时间: 2024-12-20 14:46:24

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:CreateBgpPeercreate
*VirtualBorderRouter
acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

BGP 组所在的地域 ID。

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

cn-shanghai
BgpGroupIdstring是

BGP 组的 ID。

bgpg-wz9f62v4fbg****
PeerIpAddressstring否

BGP 邻居的 IP 地址。

116.62.XX.XX
EnableBfdboolean否

是否开启 BFD 功能，取值：

  • true：开启 BFD 功能。

  • false：不开启 BFD 功能。

true
ClientTokenstring否

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

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

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
IpVersionstring否

IP 版本。取值：

  • IPv4（默认值）：IPv4 版本。
  • IPv6：IPv6 版本，只有当创建 BGP 组的 VBR 开通 IPv6 功能时，支持 IPv6 版本。
IPv4
BfdMultiHopinteger否

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

选择开启 BFD 功能时，需要配置此参数。 输入 BFD 跳数，即数据从源端到目标端传输时经过的最大设备数量。您可以根据真实的物理链路因素配置不同的跳数。

说明 当您在多云环境或光纤直连组网中使用 BFD，中间无任何桥接设备时，则需要将 BFD 的默认跳数从 255 改成 1。
3

返回参数

名称类型描述示例值
object
BgpPeerIdstring

BGP 邻居的 ID。

bgp-m5eoyp2mwegk8ce9v****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400QuotaExceeded.Bgpbgp peer count per vbr quota exceed.边界路由器的BGP邻居数量已达到配额。
400QuotaExceeded.Bgpbgp group count per vbr quota exceed.边界路由器的BGP组的数量已达到配额。
400QuotaExceeded.Nqanqa count per vbr quota exceed.NQA数超过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.边界路由器的BGP网络数量已达到配额。
400InvalidPeerIpAddressmulti pconn peer ip can not be null.多物理专线的IP地址不能为空。
400InvalidVbrNetworkvbr netowrk not exists该边界路由器不存在，请您检查输入的边界路由器是否正确。
400InvalidBgpGroupbgp group not exists该BGP组不存在。
400InvalidBgpName.MalformedSpecified Bgp Group name is not valid.该BGP组的名称不合法。
400InvalidBgpDiscription.MalformedSpecified Bgp Group description is not valid.该BGP组的描述不合法。
400InvalidBgpAuthkey.MalformedSpecified Bgp Group authkey is not valid.该BGP组的验证密钥不合法。
400InvalidIP.MalformedIp malformed.IP格式不合法。
400InvalidPeerAsn.Malformedinvalid peer asn cannot equals aliyun asn:45104ASN号码不能和阿里云ASN号码一致。
400InvalidParams.NotNullinvalid peer asn cannot equals aliyun asn:45104ASN号码不能和阿里云ASN号码一致。
400InvalidParams.NotFoundinstance not found实例不存在。
400InvalidParams.NotFoundvpc instance not found该VPC不存在，请您检查输入的VPC是否正确。
400InvalidParams.AlreadyExistsbgp network already existsBGP网络已经存在。
400InvalidStatus.CannotOperateinvalid status cannot operate状态不合法，无法执行该操作。
400InvalidParams.PeerIpAddressMustPointOutvbr has 0 or more than 1 subif ,point out peerIpAddress.请指出PeerIpAddress
400InvalidParams.PeerIpAddressInUsepeer ip address in use ,cannot create bgp peer.对等IP地址正在使用，无法创建BGP对等。
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.操作失败，因为出方向流量未开通。
400UnsupportedFeature.VpconnThe feature of Vpconn is not supported.不支持Vpconn类型。
400DuplicatedParam.PeerIpAddressThe param of PeerIpAddress is duplicated.BGP邻居IP地址重复。
400DuplicatedParam.LocalIpAddressThe LocalIpAddress already exists.本端IP地址参数有重复，请更换本端IP后重试。
400DuplicatedParam.PeerIpv6AddressThe PeerIpv6Address already exists.对端IP地址参数有重复，请更换对端IP后重试。
400DuplicatedParam.LocalIpv6AddressThe LocalIpv6Address already exists.本端IP地址参数有重复，请更换本端IP后重试。
400IllegalParam.LocalGatewayIpAndMaskThe LocalGatewayIpAndMask value is invalid.本端网关IP和掩码非法，请更正后重试。
400IllegalParam.PeeringIpv6SubnetMaskThe PeeringIpv6SubnetMask value is invalid.掩码非法，请更正后重试。
400IllegalParam.IpVersionThe param of IPV6 is illegal.参数 IpVersion 异常,请核对参数后重试.
404InvalidRegionId.NotFoundSpecified value of "regionId" is not supported.指定的 RegionId 不存在，请您检查此产品在该地域是否可用。

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

变更历史

变更时间变更内容概要操作
2024-08-16OpenAPI 错误码发生变更查看变更详情
2022-06-09OpenAPI 错误码发生变更查看变更详情
上一篇: CreateBgpGroup - 为指定的VBR创建一个BGP组 下一篇: DeleteBgpGroup - 删除指定的BGP组
文档推荐
阿里云首页 专有网络VPC 相关技术圈