全部產品
Search

搜尋本產品

    VPN Gateway：CreateVpnGateway

    文件中心

    VPN Gateway：CreateVpnGateway

    更新時間：Jul 16, 2026

    呼叫 CreateVpnGateway 介面建立 VPN 閘道器。

    介面說明

    • 在您建立 VPN 閘道器前，建議您先了解 VPN 閘道器的使用限制。更多資訊，請參閱VPN 閘道器使用限制。

    • 部分地域的 VPN 閘道器執行個體預設僅支援建立雙通道模式 IPsec-VPN 連線，您在這些地域呼叫 CreateVpnGateway 介面建立 VPN 閘道器執行個體時，除了需要輸入必填參數外，還需要輸入 VSwitchId 和 DisasterRecoveryVSwitchId 參數的值。關於支援雙通道模式 IPsec-VPN 連線的地域和可用區資訊，請參閱IPsec-VPN 連線升級為雙通道模式。

    • CreateVpnGateway 介面屬於非同步介面，即系統先返回一個執行個體 ID，但該 VPN 閘道器尚未建立成功，系統後台的建立任務仍在進行。您可以呼叫 DescribeVpnGateway 查詢 VPN 閘道器的建立狀態：

      • 當 VPN 閘道器處於 provisioning 狀態時，表示 VPN 閘道器正在建立中。

      • 當 VPN 閘道器處於 active 狀態時，表示 VPN 閘道器建立成功。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vpc:CreateVpnGateway

    create

    *VpnGateway

    acs:vpc:{#regionId}:{#accountId}:vpngateway/*

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    VPN 閘道器所在的地域。您可以透過呼叫 DescribeRegions 介面取得地域 ID。

    cn-hangzhou
    Name

    string

    否

    VPN 閘道器的名稱，預設值為 VPN 閘道器的 ID。

    長度為 2～100 個字元，不能以 http:// 或 https:// 開頭，需要以大寫或小寫字母開頭，後面可包含大小寫字母、數字、底線（_）、連字號（-）和半形句號（.），不支援其他特殊字元。

    MYVPN
    VpcId

    string

    是

    VPN 閘道器所屬的 VPC 執行個體 ID。

    vpc-bp1ub1yt9cvakoelj****
    InstanceChargeType

    string

    否

    VPN 閘道器的計費方式。僅取值：POSTPAY，按量計費。

    中国站示例值：PREPAY，国际站示例值：POSTPAY
    Period

    integer

    否

    購買時長。單位：月。取值：1~9、12、24 或 36。

    1
    AutoPay

    boolean

    否

    是否自動支付 VPN 閘道器的帳單。取值：

    • true：自動支付 VPN 閘道器的帳單。

    • false（預設值）：不自動支付 VPN 閘道器的帳單。

    說明

    為了成功建立 VPN 閘道器執行個體，建議您開啟自動支付。如果您關閉了自動支付，則需要手動支付帳單才能成功建立 VPN 閘道器執行個體。

    false
    Bandwidth

    integer

    是

    VPN 閘道器的頻寬規格。單位：Mbps。

    • 如果您要建立公網 VPN 閘道器，則取值為：10、100、200、500 或 1000。

    • 如果您要建立私網 VPN 閘道器，則取值為：200 或 1000。

    說明

    部分地域下 VPN 閘道器支援的最大頻寬規格為 500 Mbps。更多資訊，請參閱VPN 閘道器使用限制。

    5
    EnableIpsec

    boolean

    否

    是否開啟 IPsec-VPN 功能。取值：

    • true（預設值）：開啟 IPsec-VPN 功能。

    • false：不開啟 IPsec-VPN 功能。

    true
    EnableSsl

    boolean

    否

    是否開啟 SSL-VPN 功能。取值：

    • true：開啟 SSL-VPN 功能。

    • false（預設值）：不開啟 SSL-VPN 功能。

    false
    SslConnections

    integer

    否

    允許同時連線的最大用戶端數量。取值：5（預設值）、10、20、50、100、200、500、1000。

    5
    VSwitchId

    string

    否

    指定 VPN 閘道器執行個體關聯的交換器執行個體。

    • 在支援建立雙通道模式 IPsec-VPN 連線的地域，本參數必填，您必須指定一個交換器執行個體，同時您還要指定 DisasterRecoveryVSwitchId 參數的值。

    • 在支援建立單通道模式 IPsec-VPN 連線的地域，如果您不指定交換器執行個體，系統將從 VPC 下自動選擇一個交換器執行個體。

    vsw-bp1j5miw2bae9s2vt****
    VpnType

    string

    否

    VPN 閘道器類型。取值：

    • Normal（預設值）：普通型。

    Normal
    ClientToken

    string

    否

    用戶端 Token，用於保證請求的冪等性。

    從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

    說明

    若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 識別碼。每次 API 請求的 RequestId 不一樣。

    02fb3da4****
    NetworkType

    string

    否

    VPN 閘道器的網路類型。取值：

    • public（預設值）：公網 VPN 閘道器。

    • private：私網 VPN 閘道器。

    public
    DisasterRecoveryVSwitchId

    string

    否

    指定 VPN 閘道器執行個體關聯的第二個交換器執行個體。

    • 如果目前地域支援建立雙通道模式的 IPsec-VPN 連線，則本參數必填。

    • 您需要從 VPN 閘道器執行個體關聯的 VPC 執行個體下指定兩個分佈在不同可用區的交換器執行個體，以實現 IPsec-VPN 連線可用區層級的容災。

    • 對於僅支援一個可用區的地域，不支援可用區層級的容災，建議您在該可用區下指定兩個不同的交換器執行個體以實現 IPsec-VPN 連線的高可用，支援指定相同的交換器執行個體。

    關於支援雙通道模式 IPsec-VPN 連線的地域和可用區的資訊，請參閱IPsec-VPN 連線升級為雙通道模式。

    vsw-p0wiz7obm0tbimu4r****
    ResourceGroupId

    string

    否

    VPN 閘道器所屬的資源群組 ID。

    • 您可以呼叫 ListResourceGroups 介面查詢資源群組 ID。

    • 如果您未指定資源群組 ID，VPN 閘道器建立完成後將歸屬於預設資源群組。

    • VPN 閘道器建立完成後，如果您在 VPN 閘道器下建立 SSL 伺服器端、SSL 用戶端憑證、IPsec 伺服器端或 IPsec 連線（指 IPsec 連線綁定 VPN 閘道器的場景），則這些資源將直接歸屬在 VPN 閘道器所屬的資源群組下，且不支援修改。

      如果您修改了 VPN 閘道器所屬的資源群組，則上述資源所屬的資源群組也將一併被修改。

    rg-acfmzs372yg****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    VpnGatewayId

    string

    VPN 閘道器執行個體 ID。

    vpn-uf68lxhgr7ftbqr3p****
    RequestId

    string

    請求 ID。

    EB2C156A-41F8-49CC-A756-D55AFC8BFD69
    Name

    string

    VPN 閘道器的名稱。

    MYVPN
    OrderId

    integer

    訂單 ID。

    如果您未選擇自動支付 VPN 閘道器的帳單，請前往阿里雲費用與成本完成支付。

    208240895400460

    樣本

    正常返回樣本

    JSON格式

    {
  "VpnGatewayId": "vpn-uf68lxhgr7ftbqr3p****",
  "RequestId": "EB2C156A-41F8-49CC-A756-D55AFC8BFD69",
  "Name": "MYVPN",
  "OrderId": 208240895400460
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidVpcId.NotFound The specified VPC id does not exist in our records.
    400 InvalidName The specified value of Name not supported.
    400 InvalidSpec.NotFound The specified Spec does not exist in our records.
    400 InvalidPeriod The specified period is not valid
    400 ChargeType.NotSupport The specified charge type is not support.
    400 InventoryNotEnough The inventory is not enough.
    400 UnnecessarySslConnection The SSL connection is unnecessary for ssl vpn disabled.
    400 InvalidVpnEnable Either IPsec or SSL VPN must be set enable.
    400 Resource.QuotaFull The quota of resource is full
    400 InvalidVSwitchId.NotFound The specified vswitchId is not found.
    400 OperationFailed.InventoryNotEnough No enough available resource. Try another vswitch with different available zone.
    400 Forbidden.OperateShareResource Operating shared resources is forbidden.
    400 OperationFailed.IpNotEnough Operation failed because private ip address of the virtual switch is not enough.
    400 Forbidden.NoSLRPermission User not authorized to create service linked role.
    400 OperationFailed.VSwitchConflict The vswitch can't create vpn. Try another vswitch.
    400 OperationFailed.AzNotSupport Current available zone can't create vpn. Try another vswitch with different available zone.
    400 OperationFailed.NetworkTypeNotMatch Create NationalStandard vpn with private networkType is unsupported.
    400 OperationFailed.SslNotSupport Enable ssl vpn with private networkType is unsupported. 私網類型 VPN 閘道器不支援開啟 SSL 功能。
    400 Forbidden.TagKey.Duplicated The specified tag key already exists. 標籤資源重複。
    400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded. 標籤數量超限。
    400 InvalidParameter.TagValue The specified parameter TagValue is invalid. 指定的參數 TagValue 不合規範。
    400 InvalidParameter.TagKey The specified parameter TagKey is invalid. 指定的參數 TagKey 不合規範。
    400 Duplicated.TagKey The specified parameter TagKey is duplicated. 指定的參數 TagKey 重複。
    400 InternalError The request processing has failed due to some unknown error, exception or failure.
    400 InvalidVSwitchId.FirstVswitchNotSupport The available zone of vswitch1 not supported. 虛擬交換器所在可用區不支援建立雙通道 VPN，請更換虛擬交換器。
    400 InvalidVSwitchId.VswitchIdShouldDifferent The VSwitch ids should be different. 主備可用區不能相同。
    400 InvalidVSwitchId.FirstVswitchIpNotEnough The ip of vswitch1 not enough. 主 vSwitch 中可用 IP 數量不足。
    400 InvalidVSwitchId.SecondVswitchIpNotEnough The ip of vswitch2 not enough. 備 vSwitch 中的可用 IP 不足。
    400 InvalidVSwitchId.ZoneIdShouldDifferent Two vSwitches should belong to different Availability Zones. 建立雙通道 VPN 時輸入參數的兩個可用區應該不同。
    400 MissingParam.VSwitchId The parameter VSwitchId is missing. 參數 VSwitchId 缺失。
    400 MissingParam.DisasterRecoveryVSwitchId The parameter DisasterRecoveryVSwitchId is missing. 參數 DisasterRecoveryVSwitchId 缺失。
    400 InvalidDisasterRecoveryVSwitchId.NotFound The specified DisasterRecoveryVSwitchId does not exist in the specified region. 該交換器在該地域內不存在。
    400 InvalidVSwitchId.SecondVswitchNotSupport The zone of the DisasterRecoveryVSwitch does not support creating a ha-tunnel VPN. 備可用區虛擬交換器所在可用區不支援建立雙通道 VPN，請更換虛擬交換器。
    404 InvalidRegionId.NotFound The specified region is not found during access authentication. 參數錯誤。

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

    變更歷史

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