調用CreateVcoRouteEntry介面為IPsec串連添加目的路由條目。
介面說明
IPsec 串連需已綁定轉寄路由器執行個體。具體操作,請參見 CreateTransitRouterVpnAttachment 。
不支援添加目標網段為 0.0.0.0/0 的目的路由。
請勿添加目標網段為 100.64.0.0/10、100.64.0.0/10 下的子網段或者包含 100.64.0.0/10 網段的目的路由,該類路由條目會導致控制台無法顯示 IPsec 串連的狀態或者導致 IPsec 串連協商失敗。
- CreateVcoRouteEntry 介面屬於非同步介面,即系統先返回一個執行個體 ID,但該目的路由條目尚未建立成功,系統背景建立任務仍在進行。您可以調用 DescribeVpnConnection 查詢目的路由條目的建立狀態:
當 IPsec 串連處於 updating 狀態時,表示目的路由條目正在建立中。
當 IPsec 串連處於 attached 狀態時,表示目的路由條目建立成功。
CreateVcoRouteEntry 介面不支援在同一 IPsec 串連下並發建立目的路由條目。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
IPsec 串連所屬的地區 ID。 您可以通過調用 DescribeRegions 介面擷取地區 ID。 |
cn-hangzhou |
| VpnConnectionId |
string |
是 |
IPsec 串連 ID。 |
vco-p0w2jpkhi2eeop6q6**** |
| RouteDest |
string |
是 |
目的路由條目的目標網段。 |
192.168.10.0/24 |
| Weight |
integer |
是 |
目的路由條目的權重值。取值:
|
100 |
| NextHop |
string |
是 |
目的路由條目的下一跳。 |
vco-p0w2jpkhi2eeop6q6**** |
| Description |
string |
否 |
目的路由條目的描述資訊。 |
desctest |
| OverlayMode |
string |
否 |
隧道協議。僅取值:Ipsec(預設值),表示 IPsec 隧道協議。 |
Ipsec |
| ClientToken |
string |
否 |
用戶端 Token,用於保證請求的等冪性。 從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。 |
123e4567-e89b-12d3-a456-4266**** |
| DryRun |
boolean |
否 |
是否只預檢此次請求。取值:
|
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| VpnConnectionId |
string |
IPsec 串連的 ID。 |
vco-p0w2jpkhi2eeop6q6**** |
| RouteDest |
string |
目的路由條目的目標網段。 |
192.168.10.0/24 |
| NextHop |
string |
目的路由條目的下一跳。 |
vco-p0w2jpkhi2eeop6q6**** |
| Weight |
integer |
目的路由條目的權重值。
|
100 |
| OverlayMode |
string |
隧道協議。 僅取值:Ipsec,表示 IPsec 隧道協議。 |
Ipsec |
| State |
string |
目的路由條目的發布狀態。 僅取值:published,表示當前路由條目發行至轉寄路由器執行個體中。 |
published |
| CreateTime |
integer |
建立目的路由條目的時間戳記。單位:毫秒。 時間戳記的格式採用 Unix 時間戳記,表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立目的路由條目時的總時間長度。 |
1658387202664 |
| RequestId |
string |
請求 ID。 |
CFC4D13B-E680-3985-95B1-87AA155481DF |
| Description |
string |
目的路由條目的描述資訊。 |
desctest |
樣本
正常返回樣本
JSON格式
{
"VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
"RouteDest": "192.168.10.0/24",
"NextHop": "vco-p0w2jpkhi2eeop6q6****",
"Weight": 100,
"OverlayMode": "Ipsec",
"State": "published",
"CreateTime": 1658387202664,
"RequestId": "CFC4D13B-E680-3985-95B1-87AA155481DF",
"Description": "desctest"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Resource.QuotaFull | The quota of resource is full | |
| 400 | VpnConnection.Configuring | The specified service is configuring. | 服務正在配置中,請您稍後再試。 |
| 400 | VpnConnection.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 | InvalidNextHop.NotFound | The specified NextHop does not exist. | 路由指定的下一跳不存在 |
| 400 | IllegalParam.RouteDest | The specified RouteDest is invalid | 目的地址不合法。 |
| 400 | OperationFailed.InvalidCidrBlock | Operation failed because the specified network block is invalid. | 網段不合法。 |
| 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 | TaskConflict | The operation is too frequent, please wait a moment and try again. | 操作過於頻繁,請稍等一會再重試 |
| 400 | Resource.PbrRouteQuotaFull | The quota of Policy-based route is full. | 策略路由配額超限 |
| 400 | CreatePbrRoutesQuotaFull.QuotaFull | The number of policy routes exceeds the quota limit. | 策略路由數量超過配額限制。 |
| 400 | CreateDbrRoutesQuotaFull.QuotaFull | The number of created destination routes exceeds the quota limit. | 建立目的路由數量超過配額限制。 |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun校正通過。 |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource. | 使用者無許可權操作此資源。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有許可權操作指定資源,請申請許可權後再操作。 |
| 404 | InvalidVpnConnectionInstanceId.NotFound | The specified vpn connection instance id does not exist. | 指定的VPN串連不存在,請您檢查該VPN串連ID是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。