調用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 個字符，不能以 | MYVPN |
| VpcId | string | 是 | VPN 網關所屬的 VPC 實例 ID。 | vpc-bp1ub1yt9cvakoelj**** |
| InstanceChargeType | string | 否 | VPN 網關的計費方式。僅取值：PREPAY，包年包月。 在您創建 VPN 網關時，該參數為必填項。 | 中國站示例值：PREPAY，國際站示例值：POSTPAY |
| Period | integer | 否 | 購買時長。單位：月。取值：1~9、12、24 或 36。 說明
InstanceChargeType 參數的值為 PREPAY 時，該參數必選。
| 1 |
| AutoPay | boolean | 否 | 是否自動支付 VPN 網關的賬單。取值：
說明
為了成功創建 VPN 網關實例，建議您開啟自動支付。如果您關閉了自動支付，則需要手動支付賬單才能成功創建 VPN 網關實例。
| false |
| Bandwidth | integer | 是 | VPN 網關的帶寬規格。單位：Mbps。
說明
部分地域下 VPN 網關支持的最大帶寬規格為 500 Mbps。更多信息，請參見 VPN 網關使用限制。
| 5 |
| EnableIpsec | boolean | 否 | 是否開啟 IPsec-VPN 功能。取值：
| true |
| EnableSsl | boolean | 否 | 是否開啟 SSL-VPN 功能。取值：
| false |
| SslConnections | integer | 否 | 允許同時連接的最大客戶端數量。取值：5（默認值）、10、20、50、100、200、500、1000。 | 5 |
| VSwitchId | string | 否 | 指定 VPN 網關實例關聯的交換機實例。
| vsw-bp1j5miw2bae9s2vt**** |
| VpnType | string | 否 | VPN 網關類型。取值：
| Normal |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4**** |
| NetworkType | string | 否 | VPN 網關的網絡類型。取值：
| public |
| DisasterRecoveryVSwitchId | string | 否 | 指定 VPN 網關實例關聯的第二個交換機實例。
關于支持雙隧道模式 IPsec-VPN 連接的地域和可用區的信息，請參見IPsec-VPN 連接升級為雙隧道模式。 | vsw-p0wiz7obm0tbimu4r**** |
| ResourceGroupId | string | 否 | VPN 網關所屬的資源組 ID。
| rg-acfmzs372yg**** |
返回參數
示例
正常返回示例
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.SecondVswitchNotSupport | The available zone of vswitch2 not supported. | 備vSwitch所在可用區不支持。 |
| 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 | InvalidVSwitchId.FirstVswitchNotSupport | The available zone of vswitch1 not supported. | 主vSwitch所在可用區不支持。 |
| 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時指定的兩個虛擬交換機必須要屬于不同可用區 |
| 404 | InvalidRegionId.NotFound | The specified region is not found during access authentication. | 接入認證時未找到指定區域。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-06-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-06-30 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-05-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |