全部產品
Search

搜尋本產品

    VPN Gateway：CreateVcoRouteEntry

    文件中心

    VPN Gateway：CreateVcoRouteEntry

    更新時間：Aug 07, 2026

    呼叫 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程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vpc:CreateVcoRouteEntry

    create

    *VpnConnections

    acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    IPsec 連線所屬的地域 ID。

    您可以透過呼叫 DescribeRegions 介面取得地域 ID。

    cn-hangzhou
    VpnConnectionId

    string

    是

    IPsec 連線 ID。

    vco-p0w2jpkhi2eeop6q6****
    RouteDest

    string

    是

    目的路由項目的目標網段。

    192.168.10.0/24
    Weight

    integer

    是

    目的路由項目的權重值。取值：

    • 0：表示低優先順序。

    • 100：表示高優先順序。

    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

    否

    是否只預檢此次請求。取值：

    • true：傳送檢查請求，不會建立路由。檢查項目包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 DryRunOperation。

    • false（預設值）：傳送正常請求，通過檢查後返回 HTTP 2xx 狀態碼並直接進行操作。

    false

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    VpnConnectionId

    string

    IPsec 連線的 ID。

    vco-p0w2jpkhi2eeop6q6****
    RouteDest

    string

    目的路由項目的目標網段。

    192.168.10.0/24
    NextHop

    string

    目的路由項目的下一跳。

    vco-p0w2jpkhi2eeop6q6****
    Weight

    integer

    目的路由項目的權重值。

    • 0：表示低優先順序。

    • 100：表示高優先順序。

    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. 指定的用戶端 IP 集區與 VPN 連線或 SSL 伺服器衝突。
    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. 建立路由項目失敗，因為 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. EIP 不屬於目前呼叫者，請您檢查該 EIP 是否可被您呼叫。
    404 InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist. 指定的 VPN 連線不存在，請您檢查該 VPN 連線 ID 是否正確。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。