為指定的邊界路由器（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:CreateBgpGroup | create | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | long | 否 | 自定義阿里云側 BGP AS 號。取值：
說明
其中 65025 為阿里云保留值，阿里側默認使用 45104 作為 LocalAsn，使用自定義 LocalAsn 功能在多線接入場景時可能存在 BGP 路由環路風險，請合理評估后使用。
| 45104 |
| PeerAsn | long | 是 | 本地 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 |
返回參數
示例
正常返回示例
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. | 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.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.NotFound | vpc instance not found | 該VPC不存在，請您檢查輸入的VPC是否正確。 |
| 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 | QuotaExceeded.Bgp | bgp group count per vbr quota exceed. | 邊界路由器的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不存在，請您檢查此產品在該地域是否可用。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-16 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-06-19 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-06-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-04-19 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |