调用CreateBgpGroup接口为指定的边界路由器VBR(Virtual Border Router)创建一个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。
  • VBR的BFD(Bidirectional Forwarding Detection)功能默认不开通,如有需要,请联系阿里云申请权限。

调试

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

请求参数

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

系统规定参数。取值:CreateBgpGroup

RegionId String cn-shanghai

VBR所在的地域ID。

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

RouterId String vbr-bp1ctxy813985gkuk****

VBR的ID。

Name String test

BGP组的名称。长度为2~128个字符,必须以字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。但不能以http:// https://开头。

Description String BGP

BGP组的描述信息。长度为2~256个字符,必须以字母或中文开头,但不能以http:// https://开头。

LocalAsn Long 45104

阿里云侧设备的AS号。

PeerAsn Long 1****

本地IDC侧设备的AS号。

AuthKey String !PWZ2****

BGP组的认证密钥。

IsFakeAsn Boolean true

是否指定伪AS号。取值:

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

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

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

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

IP版本。取值:

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

返回数据

名称 类型 示例值 描述
BgpGroupId String bgpg-bp1k25cyp26cllath****

创建的BGP组ID。

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateBgpGroup
&RegionId=cn-shanghai
&RouterId=vbr-bp1ctxy813985gkuk****
&Name=test
&Description=BGP
&LocalAsn=45104
&AuthKey=!PWZ2****
&IsFakeAsn=true
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&IpVersion=IPv4
&公共请求参数

正常返回示例

XML格式

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

<CreateBgpGroupResponse>
    <BgpGroupId>bgpg-bp1k25cyp26cllath****</BgpGroupId>
    <RequestId>C1221A1F-2ACD-4592-8F27-474E02883159</RequestId>
</CreateBgpGroupResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 QuotaExceeded.Bgp bgp peer 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 InvalidBgpDescription.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.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 QuotaExceeded.Bgp bgp group count per vbr quota exceed. 边界路由器的BGP组的数量已达到配额。
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. 操作失败,因为出方向流量未开通。
404 InvalidRegionId.NotFound The specified RegionId is not found. 指定的RegionId不存在,请您检查此产品在该地域是否可用。

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