为指定的边界路由器（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代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
VBR 所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 |
cn-shanghai |
| RouterId |
string |
是 |
VBR 的 ID。 |
vbr-bp1ctxy813985gkuk**** |
| Name |
string |
否 |
BGP 组的名称。 长度为 2~128 个字符，必须以英文大小写字母或中文开头，可包含数字，半角句号（.），下划线（_）和短划线（-）。 |
test |
| Description |
string |
否 |
BGP 组的描述信息。 长度为 2~256 个字符，必须以英文大小写字母或中文开头，但不能以 |
BGP |
| LocalAsn |
integer |
否 |
自定义阿里云侧 BGP AS 号。取值：
说明
其中 65025 为阿里云保留值，阿里侧默认使用 45104 作为 LocalAsn，使用自定义 LocalAsn 功能在多线接入场景时可能存在 BGP 路由环路风险，请合理评估后使用。 |
45104 |
| PeerAsn |
integer |
是 |
本地 IDC 侧设备的 AS 号。 |
1**** |
| AuthKey |
string |
否 |
BGP 组的认证密钥。 |
!PWZ2**** |
| IsFakeAsn |
boolean |
否 |
是否指定伪 AS 号。取值：
说明
运行 BGP 的路由器一般只能属于一个 AS。当需要用新的 AS 替代原有的 AS（例如 AS 需要迁移或者和其他 AS 合并），并且因为业务等客观因素无法立即修改 BGP 配置时，可以通过指定伪 AS 号与本端建立连接，保证业务不中断。 |
true |
| ClientToken |
string |
否 |
客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。 |
123e4567-e89b-12d3-a456-426655440000 |
| IpVersion |
string |
否 |
IP 版本。取值：
|
IPv4 |
| RouteQuota |
integer |
否 |
BGP 邻居的路由条目上限。单位：条，默认值：110。 |
110 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
创建的 BGP 组 ID。 |
||
| BgpGroupId |
string |
创建的 BGP 组 ID。 |
bgpg-bp1k25cyp26cllath**** |
| RequestId |
string |
请求 ID。 |
C1221A1F-2ACD-4592-8F27-474E02883159 |
示例
正常返回示例
JSON格式
{
"BgpGroupId": "bgpg-bp1k25cyp26cllath****",
"RequestId": "C1221A1F-2ACD-4592-8F27-474E02883159"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | QuotaExceeded.Bgp | bgp peer count per vbr quota exceed. | 边界路由器的BGP邻居数量已达到配额。 |
| 400 | QuotaExceeded.Nqa | nqa count per vbr quota exceed. | |
| 400 | QuotaExceeded.BgpNetwork | bgp network count per vbr quota exceed. | |
| 400 | InvalidPeerIpAddress | multi pconn peer ip can not be null. | |
| 400 | InvalidVbrNetwork | vbr netowrk not exists | |
| 400 | InvalidBgpGroup | bgp group not exists | |
| 400 | InvalidBgpName.Malformed | Specified Bgp Group name is not valid. | |
| 400 | InvalidBgpDescription.Malformed | Specified Bgp Group description is not valid. | |
| 400 | InvalidBgpAuthkey.Malformed | Specified Bgp Group authkey is not valid. | |
| 400 | InvalidIP.Malformed | Ip malformed. | |
| 400 | InvalidPeerAsn.Malformed | invalid peer asn cannot equals aliyun asn:45104 | |
| 400 | InvalidParams.NotNull | params must not null. | 参数不能为空 |
| 400 | InvalidBgpGroup.LocalAsnInvalid | The specified BgpGroup LocalAsn is invalid, only support 64512 to 65534 or 4200000000 to 4294967294, but cannot be 65025. | 指定的BgpGroup LocalAsn无效，仅支持64512到65534或420000000到429496729 |
| 400 | InvalidParams.NotFound | instance not found | |
| 400 | InvalidParams.AlreadyExists | bgp network already exists | BGP网络已经存在。 |
| 400 | InvalidStatus.CannotOperate | invalid status cannot operate | |
| 400 | InvalidParams.PeerIpAddressMustPointOut | vbr has 0 or more than 1 subif ,point out peerIpAddress. | 请指出PeerIpAddress |
| 400 | InvalidParams.PeerIpAddressInUse | peer ip address in use ,cannot create bgp peer. | 对等IP地址正在使用，无法创建BGP对等。 |
| 400 | IllegalParam.PeerAsn | The param of PeerAsn is illegal | PeerAsn参数不合法 |
| 400 | IllegalParam.LocalAsn | The param of LocalAsn is illegal | LocalAsn参数不合法 |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失败，因为出方向流量未开通。 |
| 400 | OperationUnsupport | Operation is unsupport, not in vbr support custom local asn white list. | 操作不支持 |
| 400 | IllegalParam.RouteLimit | The operation is failed because of bgp group max route entry num quota exceed. | BGP组中的每个BGP邻居可接收的路由条目数超过配额。 |
| 400 | IllegalParam.BgpGroupLocalAsn | VBR BgpGroup localAsn must same with ECR asn. | 边界路由器的LocalAsn必须与ECR的asn相同 |
| 400 | OperationDenied.VbrAttachEcrInMiddleStatus | The operation is not allowed because of VBR attach or detach ECR in middle status. | 由于边界路由器正处于加载或者卸载专线网关过程中，当前操作无法执行，请您稍等后重试。 |
| 400 | OperationFailed.BgpPeerConflictWithECR | The BGP neighbor created by the previous VBR conflicts with the ECR configuration. | 当前VBR已经创建的BGP邻居与ECR配置冲突，请删除BGP配置后重试。 |
| 400 | OperationFailed.PeerAsnCannotEqualsLocalAsn | Peer ASN is illegal, peer ASN cannot equals to local ASN. | 添加 BGPGroup 时对端自治系统编号不能与本端自治系统编号相同, 请核对参数后重试. |
| 404 | InvalidRegionId.NotFound | The specified RegionId is not found. | 指定的RegionId不存在，请您检查此产品在该地域是否可用。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。