為指定的邊界路由器（VBR）創(chuàng)建一個(gè)BGP組。
接口說明
您可以通過邊界網(wǎng)關(guān)協(xié)議 BGP（Border Gateway Protocol）實(shí)現(xiàn) VBR 與本地 IDC 的互通。每個(gè) BGP 組關(guān)聯(lián)一個(gè) VBR，您僅需將與 VBR 通信的 BGP 鄰居添加到對應(yīng)的 BGP 組中，然后在 VBR 中宣告 BGP 網(wǎng)絡(luò)即可。
BGP 組用于簡化 BGP 配置，通過將相同配置的 BGP 鄰居合并到一個(gè) BGP 組，減少配置的復(fù)雜度。您需要先根據(jù)申請的 ASN 創(chuàng)建一個(gè) BGP 組。
調(diào)用本接口創(chuàng)建 BGP 組時(shí)，請注意：
- VBR 僅支持與物理專線對端的本地 IDC 建立 BGP 鄰居。
- VBR 支持的 BGP 版本為 BGP-4。
- 每個(gè) VBR 最多可以建立 8 個(gè) BGP 鄰居。
- 每個(gè) BGP 鄰居的動態(tài)路由條數(shù)上限為 110 條。
- 阿里云側(cè)自治系統(tǒng)號 ASN（Autonomous System Number）為 45104，可接受用戶側(cè)傳遞 2 Byte 或 4 Byte 的 ASN。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個(gè)操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| vpc:CreateBgpGroup | create | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VBR 所在的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
| RouterId | string | 是 | VBR 的 ID。 | vbr-bp1ctxy813985gkuk**** |
| Name | string | 否 | BGP 組的名稱。 長度為 2~128 個(gè)字符，必須以英文大小寫字母或中文開頭，可包含數(shù)字，半角句號（.），下劃線（_）和短劃線（-）。 | test |
| Description | string | 否 | BGP 組的描述信息。 長度為 2~256 個(gè)字符，必須以英文大小寫字母或中文開頭，但不能以 | BGP |
| LocalAsn | long | 否 | 自定義阿里云側(cè) BGP AS 號。取值：
說明
其中 65025 為阿里云保留值，阿里側(cè)默認(rèn)使用 45104 作為 LocalAsn，使用自定義 LocalAsn 功能在多線接入場景時(shí)可能存在 BGP 路由環(huán)路風(fēng)險(xiǎn)，請合理評估后使用。
| 45104 |
| PeerAsn | long | 是 | 本地 IDC 側(cè)設(shè)備的 AS 號。 | 1**** |
| AuthKey | string | 否 | BGP 組的認(rèn)證密鑰。 | !PWZ2**** |
| IsFakeAsn | boolean | 否 | 是否指定偽 AS 號。取值：
說明
運(yùn)行 BGP 的路由器一般只能屬于一個(gè) AS。當(dāng)需要用新的 AS 替代原有的 AS（例如 AS 需要遷移或者和其他 AS 合并），并且因?yàn)闃I(yè)務(wù)等客觀因素?zé)o法立即修改 BGP 配置時(shí)，可以通過指定偽 AS 號與本端建立連接，保證業(yè)務(wù)不中斷。
| true |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標(biāo)識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
| IpVersion | string | 否 | IP 版本。取值：
| IPv4 |
| RouteQuota | integer | 否 | BGP 鄰居的路由條目上限。單位：條，默認(rèn)值：110。 | 110 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"BgpGroupId": "bgpg-bp1k25cyp26cllath****",
"RequestId": "C1221A1F-2ACD-4592-8F27-474E02883159"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | QuotaExceeded.Bgp | bgp peer count per vbr quota exceed. | 邊界路由器的BGP鄰居數(shù)量已達(dá)到配額。 |
| 400 | QuotaExceeded.Nqa | nqa count per vbr quota exceed. | NQA數(shù)超過VBR配額。 |
| 400 | QuotaExceeded.BgpNetwork | bgp network count per vbr quota exceed. | 邊界路由器的BGP網(wǎng)絡(luò)數(shù)量已達(dá)到配額。 |
| 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組的驗(yàn)證密鑰不合法。 |
| 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. | 參數(shù)不能為空 |
| 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 | 實(shí)例不存在。 |
| 400 | InvalidParams.NotFound | vpc instance not found | 該VPC不存在，請您檢查輸入的VPC是否正確。 |
| 400 | InvalidParams.AlreadyExists | bgp network already exists | BGP網(wǎng)絡(luò)已經(jīng)存在。 |
| 400 | InvalidStatus.CannotOperate | invalid status cannot operate | 狀態(tài)不合法，無法執(zhí)行該操作。 |
| 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地址正在使用，無法創(chuàng)建BGP對等。 |
| 400 | QuotaExceeded.Bgp | bgp group count per vbr quota exceed. | 邊界路由器的BGP組的數(shù)量已達(dá)到配額。 |
| 400 | IllegalParam.PeerAsn | The param of PeerAsn is illegal | PeerAsn參數(shù)不合法 |
| 400 | IllegalParam.LocalAsn | The param of LocalAsn is illegal | LocalAsn參數(shù)不合法 |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失敗，因?yàn)槌龇较蛄髁课撮_通。 |
| 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組中的每個(gè)BGP鄰居可接收的路由條目數(shù)超過配額。 |
| 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. | 由于邊界路由器正處于加載或者卸載專線網(wǎng)關(guān)過程中，當(dāng)前操作無法執(zhí)行，請您稍等后重試。 |
| 400 | OperationFailed.BgpPeerConflictWithECR | The BGP neighbor created by the previous VBR conflicts with the ECR configuration. | 當(dāng)前VBR已經(jīng)創(chuàng)建的BGP鄰居與ECR配置沖突，請刪除BGP配置后重試。 |
| 400 | OperationFailed.PeerAsnCannotEqualsLocalAsn | Peer ASN is illegal, peer ASN cannot equals to local ASN. | 添加 BGPGroup 時(shí)對端自治系統(tǒng)編號不能與本端自治系統(tǒng)編號相同, 請核對參數(shù)后重試. |
| 404 | InvalidRegionId.NotFound | The specified RegionId is not found. | 指定的RegionId不存在，請您檢查此產(chǎn)品在該地域是否可用。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-08-16 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-06-19 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-06-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-04-19 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |