調用CreateVpnPbrRouteEntry接口創建VPN策略路由。
接口說明
前提條件
- 創建策略路由前，請確保您已經創建了 IPsec 連接。具體操作，請參見 CreateVpnConnection 。
- 創建策略路由前，建議您先了解策略路由的使用限制、匹配規則等信息。更多信息，請參見使用策略路由。
使用限制
- 不支持添加目標網段為 0.0.0.0/0 的策略路由。
- 請勿添加目標網段為 100.64.0.0/10、100.64.0.0/10 下的子網段或者包含 100.64.0.0/10 網段的策略路由，該類策略路由會導致控制臺無法顯示 IPsec 連接的狀態或者導致 IPsec 連接協商失敗。
- CreateVpnPbrRouteEntry 接口屬于異步接口，即系統先返回策略路由的信息，但該策略路由尚未創建成功，系統后臺的創建任務仍在進行。您可以調用 DescribeVpnGateway 接口查詢 VPN 網關實例狀態，來確定策略路由的創建狀態：
- 當 VPN 網關實例處于 updating 狀態時，表示策略路由正在創建中。
- 當 VPN 網關實例處于 active 狀態時，表示策略路由創建成功。
- CreateVpnPbrRouteEntry 接口不支持在同一個 VPN 網關實例下并發創建策略路由。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateVpnPbrRouteEntry | create | *VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 網關實例所在的地域 ID。您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| d7d24a21-f4ba-4454-9173-b3**** |
| VpnGatewayId | string | 是 | VPN 網關實例的 ID。 | vpn-bp1a3kqjiiq9legfx**** |
| RouteSource | string | 是 | 策略路由的源網段。 | 192.168.1.0/24 |
| RouteDest | string | 是 | 策略路由的目標網段。 | 10.0.0.0/24 |
| NextHop | string | 是 | 策略路由的下一跳。 | vco-bp15oes1py4i66rmd**** |
| Weight | integer | 是 | 策略路由的權重值。 在您使用同一個 VPN 網關實例搭建主備 IPsec-VPN 連接的場景中，您可以通過配置策略路由的權重值來指定主鏈路和備鏈路，權重值為 100 的策略路由默認為主鏈路，權重值為 0 的策略路由默認為備鏈路。 您可以通過為 IPsec 連接配置健康檢查來自動探測鏈路的連通性，在主鏈路不通的情況下，系統自動將流量切換至備鏈路進行傳輸，實現上云鏈路的高可用。具體操作，請參見 CreateVpnConnection 。
說明
| 0 |
| PublishVpc | boolean | 是 | 是否發布策略路由到 VPC 中。取值：
| true |
| Description | string | 否 | 策略路由的描述信息。 描述信息長度為 1～100 個字符。 | desctest |
| OverlayMode | string | 否 | 隧道協議。僅取值：Ipsec（IPsec 隧道協議）。 | Ipsec |
| Priority | integer | 否 | 策略路由的策略優先級。取值范圍：1~100。默認值：10。 策略優先級數字越小，策略路由的優先級越高。 | 10 |
返回參數
示例
正常返回示例
JSON格式
{
"NextHop": "vco-bp15oes1py4i66rmd****",
"Weight": 0,
"RouteDest": "10.0.0.0/24",
"RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
"Description": "desctest",
"State": "normal",
"CreateTime": 1492747187000,
"OverlayMode": "Ipsec",
"RouteSource": "192.168.1.0/24",
"VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
"Priority": 10
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Resource.QuotaFull | The quota of resource is full | 資源配額已達上限。 |
| 400 | VpnGateway.FinancialLocked | The specified service is financial locked. | 該服務已欠費，請您先充值再操作。 |
| 400 | VpnRouteEntry.AlreadyExists | The specified route entry is already exist. | 該路由已存在。 |
| 400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | 路由條目存在沖突。 |
| 400 | VpnRouteEntry.ConflictSSL | The specified route entry has conflict with SSL client. | 路由條目與SSL客戶端沖突。 |
| 400 | VpnRouteEntry.BackupRoute | Validate backup route entry failed. | 主備路由條目校驗失敗。 |
| 400 | VpnRouteEntry.InvalidWeight | Invalid route entry weight value. | 路由權重值不合法 |
| 400 | InvalidNextHop.NotFound | The specified NextHop does not exist. | 路由指定的下一跳不存在 |
| 400 | IllegalParam.RouteDest | The specified RouteDest is invalid | 目的地址不合法。 |
| 400 | OperationFailed.RouteConflict | Operation failed because there is already a route in VPC route table to another VPN on the same network block. | 在VPC路由表中同一網段上已經存在一條指向另一個VPN網關的路由。 |
| 400 | OperationFailed.InvalidCidrBlock | Operation failed because the specified network block is invalid. | 網段不合法。 |
| 400 | OperationFailed.RouteConflict | Operation failed because there is already a route in VPC route table to a non-RI and non-VPN next hop on the same network block. | 在VPC路由表中同一網段上已經存在一條指向RI、VPN網關之外其他資源的路由。 |
| 400 | QuotaExceeded.VpnRouteEntry | The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. | VPC路由表中指向VPN網關的路由條目已經達到配額限制。 |
| 400 | VpnPbrRouteEntryPriority.NotSupport | Current version of the VPN does not support setting custom pbr route entry priority. | 當前版本的VPN不支持設置策略路由條目優先級 |
| 400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | 操作過于頻繁，請稍等一會再重試 |
| 400 | VpnTask.CONFLICT | Vpn task has conflict. | Vpn操作存在沖突，請稍后重試。 |
| 400 | VpnGateway.Configuring | The specified service is configuring. | 服務正在配置中，請您稍后再試。 |
| 400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤 |
| 400 | VpnRouteEntry.SrcDestWeightConflict | The VPN gateway does not support Policy-based routing with the same source CIDR, destination CIDR and weight. | VPN網關不支持配置源網段、目標網段與權重同時相同的策略路由。 |
| 400 | VpnRouteEntry.SamePriorityPbrRoutePrefixOverlap | The source CIDR and destination CIDR of Policy-based routes with the same priority cannot overlap. | VPN網關不支持相同優先級下的多個策略路由源和目標網段同時重合。 |
| 400 | VpnRouteEntry.SrcDestConflict | The VPN gateway does not support Policy-based routing with the same source CIDR and destination CIDR. | 雙隧道類型的VPN網關不支持配置源網段與目標網段同時相同的策略路由。 |
| 400 | Resource.QuotaFull | The resources you are operating have reached the upper limit of the quota. Please increase the quota or use other solutions to avoid it according to the VPN operation document. | 您現在所操作的資源目前已經達到了配額的上限，請參考VPN操作文檔，進行配額提升或者使用其他方案進行規避。 |
| 400 | CreatePbrRoutesQuotaFull.QuotaFull | The number of policy routes exceeds the quota limit. | 策略路由數量超過配額限制。 |
| 400 | InvalidCidrBlock.Malformed | Specified CIDR block is not valid. | 該CIDR格式不正確。 |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | 您沒有權限操作該資源，請您申請操作權限后再試。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有權限操作指定資源，請申請權限后再操作。 |
| 404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 網關不存在，請您檢查 VPN 網關是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-05-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-01-04 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-08-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |