調用CreateBgpPeer接口向指定的BGP組中添加BGP鄰居。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateBgpPeer | create | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | BGP 組所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
| BgpGroupId | string | 是 | BGP 組的 ID。 | bgpg-wz9f62v4fbg**** |
| PeerIpAddress | string | 否 | BGP 鄰居的 IP 地址。 | 116.62.XX.XX |
| EnableBfd | boolean | 否 | 是否開啟 BFD 功能，取值：
| true |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 由客戶端生成該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
| IpVersion | string | 否 | IP 版本。取值：
| IPv4 |
| BfdMultiHop | integer | 否 | BFD 跳數。取值范圍：1~255。 選擇開啟 BFD 功能時，需要配置此參數。 輸入 BFD 跳數，即數據從源端到目標端傳輸時經過的最大設備數量。您可以根據真實的物理鏈路因素配置不同的跳數。 說明
當您在多云環境或光纖直連組網中使用 BFD，中間無任何橋接設備時，則需要將 BFD 的默認跳數從 255 改成 1。
| 3 |
返回參數
示例
正常返回示例
JSON格式
{
"BgpPeerId": "bgp-m5eoyp2mwegk8ce9v****",
"RequestId": "D4B7649A-61BB-4C64-A586-1DFF1EDA6A42"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | QuotaExceeded.Bgp | bgp peer count per vbr quota exceed. | 邊界路由器的BGP鄰居數量已達到配額。 |
| 400 | QuotaExceeded.Bgp | bgp group count per vbr quota exceed. | 邊界路由器的BGP組的數量已達到配額。 |
| 400 | QuotaExceeded.Nqa | nqa count per vbr quota exceed. | NQA數超過VBR配額。 |
| 400 | InvalidAccessDeviceId.NotFound | There is no Access_Device_Id in our records | - |
| 400 | QuotaExceeded.BfdSession | Your Bfd Session number reaches the upper limit. | - |
| 400 | QuotaExceeded.BfdSession | The Bfd Session on device reaches the upper limit. | - |
| 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 | InvalidBgpDiscription.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 | 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 | 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 | BgpPeer.Already.Exists | bgp peer already exists. | - |
| 400 | MissingParam.EnableBfd | The parameter EnableBfd is missing. | - |
| 400 | OperationUnsupported.IPV6ForThisRegion | This Region is unsupported IPV6. | - |
| 400 | IllegalParam.BfdMultiHop | BfdMultiHop is illegal. | - |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失敗，因為出方向流量未開通。 |
| 400 | UnsupportedFeature.Vpconn | The feature of Vpconn is not supported. | 不支持Vpconn類型。 |
| 400 | DuplicatedParam.PeerIpAddress | The param of PeerIpAddress is duplicated. | BGP鄰居IP地址重復。 |
| 400 | DuplicatedParam.LocalIpAddress | The LocalIpAddress already exists. | 本端IP地址參數有重復，請更換本端IP后重試。 |
| 400 | DuplicatedParam.PeerIpv6Address | The PeerIpv6Address already exists. | 對端IP地址參數有重復，請更換對端IP后重試。 |
| 400 | DuplicatedParam.LocalIpv6Address | The LocalIpv6Address already exists. | 本端IP地址參數有重復，請更換本端IP后重試。 |
| 400 | IllegalParam.LocalGatewayIpAndMask | The LocalGatewayIpAndMask value is invalid. | 本端網關IP和掩碼非法，請更正后重試。 |
| 400 | IllegalParam.PeeringIpv6SubnetMask | The PeeringIpv6SubnetMask value is invalid. | 掩碼非法，請更正后重試。 |
| 400 | IllegalParam.IpVersion | The param of IPV6 is illegal. | 參數 IpVersion 異常,請核對參數后重試. |
| 404 | InvalidRegionId.NotFound | Specified value of "regionId" is not supported. | 指定的 RegionId 不存在，請您檢查此產品在該地域是否可用。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-16 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-06-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |