文档

CreateBgpGroup - 为指定的VBR创建一个BGP组

更新时间:

为指定的边界路由器(VBR)创建一个BGP组。

接口说明

您可以通过边界网关协议 BGP(Border Gateway Protocol)实现 VBR 与本地 IDC 的互通。每个 BGP 组关联一个 VBR,您仅需将与 VBR 通信的 BGP 邻居添加到对应的 BGP 组中,然后在 VBR 中宣告 BGP 网络即可。

BGP 组用于简化 BGP 配置,通过将相同配置的 BGP 邻居合并到一个 BGP 组,减少配置的复杂度。您需要先根据申请的 ASN 创建一个 BGP 组。

调用本接口创建 BGP 组时,请注意:

  • VBR 仅支持与物理专线对端的本地 IDC 建立 BGP 邻居。
  • VBR 支持的 BGP 版本为 BGP-4。
  • 每个 VBR 最多可以建立 8 个 BGP 邻居。
  • 每个 BGP 邻居的动态路由条数上限为 110 条。
  • 阿里云侧自治系统号 ASN(Autonomous System Number)为 45104,可接受用户侧传递 2 Byte 或 4 Byte 的 ASN。

调试

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

授权信息

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

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

请求参数

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

VBR 所在的地域 ID。

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

cn-shanghai
RouterIdstring

VBR 的 ID。

vbr-bp1ctxy813985gkuk****
Namestring

BGP 组的名称。

长度为 2~128 个字符,必须以英文大小写字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。

test
Descriptionstring

BGP 组的描述信息。

长度为 2~256 个字符,必须以英文大小写字母或中文开头,但不能以http:// https://开头。

BGP
LocalAsnlong

自定义阿里云侧 BGP AS 号。取值:

  • 45104
  • 64512~65534
  • 4200000000~4294967294
说明 其中 65025 为阿里云保留值,阿里侧默认使用 45104 作为 LocalAsn,使用自定义 LocalAsn 功能在多线接入场景时可能存在 BGP 路由环路风险,请合理评估后使用。
45104
PeerAsnlong

本地 IDC 侧设备的 AS 号。

1****
AuthKeystring

BGP 组的认证密钥。

!PWZ2****
IsFakeAsnboolean

是否指定伪 AS 号。取值:

  • false(默认值):否。
  • true:是。
说明 运行 BGP 的路由器一般只能属于一个 AS。当需要用新的 AS 替代原有的 AS(例如 AS 需要迁移或者和其他 AS 合并),并且因为业务等客观因素无法立即修改 BGP 配置时,可以通过指定伪 AS 号与本端建立连接,保证业务不中断。
true
ClientTokenstring

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

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

IP 版本。取值:

  • IPv4(默认值):IPv4 版本。
  • IPv6:IPv6 版本,只有当创建 BGP 组的 VBR 开通 IPv6 功能时,支持 IPv6 版本。
IPv4
RouteQuotainteger

BGP 邻居的路由条目上限。单位:条,默认值:110

110

返回参数

名称类型描述示例值
object

创建的 BGP 组 ID。

BgpGroupIdstring

创建的 BGP 组 ID。

bgpg-bp1k25cyp26cllath****
RequestIdstring

请求 ID。

C1221A1F-2ACD-4592-8F27-474E02883159

示例

正常返回示例

JSON格式

{
  "BgpGroupId": "bgpg-bp1k25cyp26cllath****",
  "RequestId": "C1221A1F-2ACD-4592-8F27-474E02883159"
}

错误码

HTTP status code错误码错误信息描述
400QuotaExceeded.Bgpbgp peer count per vbr quota exceed.边界路由器的BGP邻居数量已达到配额。
400QuotaExceeded.Nqanqa count per vbr quota exceed.NQA数超过VBR配额。
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组的名称不合法。
400InvalidBgpDescription.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.NotNullparams must not null.参数不能为空
400InvalidBgpGroup.LocalAsnInvalidThe specified BgpGroup LocalAsn is invalid, only support 64512 to 65534 or 4200000000 to 4294967294, but cannot be 65025.指定的BgpGroup LocalAsn无效,仅支持64512到65534或420000000到429496729
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对等。
400QuotaExceeded.Bgpbgp group count per vbr quota exceed.边界路由器的BGP组的数量已达到配额。
400IllegalParam.PeerAsnThe param of PeerAsn is illegalPeerAsn参数不合法
400IllegalParam.LocalAsnThe param of LocalAsn is illegalLocalAsn参数不合法
400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.操作失败,因为出方向流量未开通。
400OperationUnsupportOperation is unsupport, not in vbr support custom local asn white list.操作不支持
400IllegalParam.RouteLimitThe operation is failed because of bgp group max route entry num quota exceed.BGP组中的每个BGP邻居可接收的路由条目数超过配额。
404InvalidRegionId.NotFoundThe specified RegionId is not found.指定的RegionId不存在,请您检查此产品在该地域是否可用。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈