調(diào)用CreateVpnGateway接口創(chuàng)建VPN網(wǎng)關(guān)。
接口說明
-
在您創(chuàng)建 VPN 網(wǎng)關(guān)前，建議您先了解 VPN 網(wǎng)關(guān)的使用限制。更多信息，請(qǐng)參見 VPN 網(wǎng)關(guān)使用限制。
-
部分地域的 VPN 網(wǎng)關(guān)實(shí)例默認(rèn)僅支持創(chuàng)建雙隧道模式 IPsec-VPN 連接，您在這些地域調(diào)用
CreateVpnGateway接口創(chuàng)建 VPN 網(wǎng)關(guān)實(shí)例時(shí)，除了需要輸入必填參數(shù)外，還需要輸入 VSwitchId 和 DisasterRecoveryVSwitchId 參數(shù)的值。關(guān)于支持雙隧道模式 IPsec-VPN 連接的地域和可用區(qū)信息，請(qǐng)參見IPsec-VPN 連接升級(jí)為雙隧道模式。 -
CreateVpnGateway 接口屬于異步接口，即系統(tǒng)先返回一個(gè)實(shí)例 ID，但該 VPN 網(wǎng)關(guān)尚未創(chuàng)建成功，系統(tǒng)后臺(tái)的創(chuàng)建任務(wù)仍在進(jìn)行。您可以調(diào)用 DescribeVpnGateway 查詢 VPN 網(wǎng)關(guān)的創(chuàng)建狀態(tài)：
- 當(dāng) VPN 網(wǎng)關(guān)處于 provisioning 狀態(tài)時(shí)，表示 VPN 網(wǎng)關(guān)正在創(chuàng)建中。
- 當(dāng) VPN 網(wǎng)關(guān)處于 active 狀態(tài)時(shí)，表示 VPN 網(wǎng)關(guān)創(chuàng)建成功。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| vpc:CreateVpnGateway | create | *VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/* |
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 網(wǎng)關(guān)所在的地域。您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| Name | string | 否 | VPN 網(wǎng)關(guān)的名稱，默認(rèn)值為 VPN 網(wǎng)關(guān)的 ID。 長(zhǎng)度為 2～100 個(gè)字符，不能以 | MYVPN |
| VpcId | string | 是 | VPN 網(wǎng)關(guān)所屬的 VPC 實(shí)例 ID。 | vpc-bp1ub1yt9cvakoelj**** |
| InstanceChargeType | string | 否 | VPN 網(wǎng)關(guān)的計(jì)費(fèi)方式。僅取值：PREPAY，包年包月。 在您創(chuàng)建 VPN 網(wǎng)關(guān)時(shí)，該參數(shù)為必填項(xiàng)。 | 中國(guó)站示例值：PREPAY，國(guó)際站示例值：POSTPAY |
| Period | integer | 否 | 購(gòu)買時(shí)長(zhǎng)。單位：月。取值：1~9、12、24 或 36。 說明
InstanceChargeType 參數(shù)的值為 PREPAY 時(shí)，該參數(shù)必選。
| 1 |
| AutoPay | boolean | 否 | 是否自動(dòng)支付 VPN 網(wǎng)關(guān)的賬單。取值：
說明
為了成功創(chuàng)建 VPN 網(wǎng)關(guān)實(shí)例，建議您開啟自動(dòng)支付。如果您關(guān)閉了自動(dòng)支付，則需要手動(dòng)支付賬單才能成功創(chuàng)建 VPN 網(wǎng)關(guān)實(shí)例。
| false |
| Bandwidth | integer | 是 | VPN 網(wǎng)關(guān)的帶寬規(guī)格。單位：Mbps。
說明
部分地域下 VPN 網(wǎng)關(guān)支持的最大帶寬規(guī)格為 500 Mbps。更多信息，請(qǐng)參見 VPN 網(wǎng)關(guān)使用限制。
| 5 |
| EnableIpsec | boolean | 否 | 是否開啟 IPsec-VPN 功能。取值：
| true |
| EnableSsl | boolean | 否 | 是否開啟 SSL-VPN 功能。取值：
| false |
| SslConnections | integer | 否 | 允許同時(shí)連接的最大客戶端數(shù)量。取值：5（默認(rèn)值）、10、20、50、100、200、500、1000。 | 5 |
| VSwitchId | string | 否 | 指定 VPN 網(wǎng)關(guān)實(shí)例關(guān)聯(lián)的交換機(jī)實(shí)例。
| vsw-bp1j5miw2bae9s2vt**** |
| VpnType | string | 否 | VPN 網(wǎng)關(guān)類型。取值：
| Normal |
| ClientToken | string | 否 | 客戶端 Token，用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值，確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統(tǒng)自動(dòng)使用 API 請(qǐng)求的 RequestId 作為 ClientToken 標(biāo)識(shí)。每次 API 請(qǐng)求的 RequestId 不一樣。
| 02fb3da4**** |
| NetworkType | string | 否 | VPN 網(wǎng)關(guān)的網(wǎng)絡(luò)類型。取值：
| public |
| DisasterRecoveryVSwitchId | string | 否 | 指定 VPN 網(wǎng)關(guān)實(shí)例關(guān)聯(lián)的第二個(gè)交換機(jī)實(shí)例。
關(guān)于支持雙隧道模式 IPsec-VPN 連接的地域和可用區(qū)的信息，請(qǐng)參見IPsec-VPN 連接升級(jí)為雙隧道模式。 | vsw-p0wiz7obm0tbimu4r**** |
| ResourceGroupId | string | 否 | VPN 網(wǎng)關(guān)所屬的資源組 ID。
| rg-acfmzs372yg**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"VpnGatewayId": "vpn-uf68lxhgr7ftbqr3p****",
"RequestId": "EB2C156A-41F8-49CC-A756-D55AFC8BFD69",
"Name": "MYVPN",
"OrderId": 208240895400460
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 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 | 資源配額已達(dá)上限。 |
| 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. | 私網(wǎng)類型VPN網(wǎng)關(guān)不支持開啟SSL功能。 |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 標(biāo)簽資源重復(fù) |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | 標(biāo)簽數(shù)量超限 |
| 400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | 指定的參數(shù)TagValue不合規(guī)范。 |
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | 指定的參數(shù)TagKey不合規(guī)范。 |
| 400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | 指定的參數(shù)TagKey重復(fù)。 |
| 400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內(nèi)部錯(cuò)誤 |
| 400 | InvalidVSwitchId.SecondVswitchNotSupport | The available zone of vswitch2 not supported. | 備vSwitch所在可用區(qū)不支持。 |
| 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. | 您現(xiàn)在所操作的資源目前已經(jīng)達(dá)到了配額的上限，請(qǐng)參考VPN操作文檔，進(jìn)行配額提升或者使用其他方案進(jìn)行規(guī)避。 |
| 400 | InvalidVSwitchId.FirstVswitchNotSupport | The available zone of vswitch1 not supported. | 主vSwitch所在可用區(qū)不支持。 |
| 400 | InvalidVSwitchId.VswitchIdShouldDifferent | The VSwitch ids should be different. | 主備可用區(qū)不能相同。 |
| 400 | InvalidVSwitchId.FirstVswitchIpNotEnough | The ip of vswitch1 not enough. | 主vSwitch中可用IP數(shù)量不足。 |
| 400 | InvalidVSwitchId.SecondVswitchIpNotEnough | The ip of vswitch2 not enough. | 備vSwitch中的可用IP不足。 |
| 400 | InvalidVSwitchId.ZoneIdShouldDifferent | Two vSwitches should belong to different Availability Zones. | 創(chuàng)建雙隧道VPN時(shí)指定的兩個(gè)虛擬交換機(jī)必須要屬于不同可用區(qū) |
| 404 | InvalidRegionId.NotFound | The specified region is not found during access authentication. | 接入認(rèn)證時(shí)未找到指定區(qū)域。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-06-18 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-01-04 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標(biāo)記、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-06-30 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-05-04 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |