CreateVpnGateway - VPN Gateway - Alibaba Cloud ドキュメントセンター

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 ゲートウェイは作成済みです。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:CreateVpnGateway

create

*VpnGateway

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイのリージョン ID。 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 ゲートウェイの帯域幅スペック。単位: Mbit/s。パブリック VPN ゲートウェイを作成する場合、有効な値は 10、100、200、500、1000 です。非公開 VPN ゲートウェイを作成する場合、有効な値は 200 と 1000 です。説明一部のリージョンの VPN ゲートウェイがサポートする帯域幅スペックの最大値は 500 Mbit/s です。詳細については、「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 ゲートウェイインスタンスに関連付けられた vSwitch。デュアルトンネルモードの IPsec-VPN 接続をサポートするリージョンでは、このパラメーターは必須です。vSwitch を指定し、DisasterRecoveryVSwitchId パラメーターも指定する必要があります。シングルトンネルモードの IPsec-VPN 接続のみをサポートするリージョンでは、vSwitch を指定しない場合、システムは VPC から vSwitch を自動的に選択します。	vsw-bp1j5miw2bae9s2vt****
VpnType	string	任意	VPN ゲートウェイのタイプ。有効な値: Normal (デフォルト): 標準。 .	Normal
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	02fb3da4****
NetworkType	string	任意	VPN ゲートウェイのネットワークタイプ。有効な値: public (デフォルト): パブリック VPN ゲートウェイ。 private: 非公開 VPN ゲートウェイ。	public
DisasterRecoveryVSwitchId	string	任意	VPN VPC 接続インスタンスに関連付けられた 2 番目の vSwitch。現在のリージョンがデュアルトンネルモードの IPsec-VPN 接続をサポートしている場合、このパラメーターは必須です。 IPsec-VPN 接続のゾーンレベルのディザスタリカバリを実現するために、VPN VPC 接続インスタンスに関連付けられた VPC 内の異なるゾーンにある 2 つの vSwitch を指定する必要があります。 1 つのゾーンのみをサポートするリージョンでは、ゾーンレベルのディザスタリカバリはサポートされていません。IPsec-VPN 接続の高可用性を実現するために、同じゾーン内の 2 つの異なる vSwitch を指定してください。同じ vSwitch を指定することもできます。デュアルトンネルモードの IPsec-VPN 接続をサポートするリージョンとゾーンについては、「IPsec-VPN 接続をデュアルトンネルモードにアップグレードする」をご参照ください。	vsw-p0wiz7obm0tbimu4r****
ResourceGroupId	string	任意	VPN ゲートウェイが属するリソースグループの ID。 ListResourceGroups 操作を呼び出してリソースグループ ID をクエリできます。リソースグループ ID を指定しない場合、VPN ゲートウェイは作成後にデフォルトのリソースグループに属します。 VPN ゲートウェイの作成後、VPN ゲートウェイの配下に SSL サーバー、SSL クライアント証明書、IPsec サーバー、または IPsec-VPN 接続 (IPsec-VPN 接続が 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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.
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.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.
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.
400	InvalidVSwitchId.FirstVswitchNotSupport	The available zone of vswitch1 not supported.
400	InvalidVSwitchId.VswitchIdShouldDifferent	The VSwitch ids should be different.
400	InvalidVSwitchId.FirstVswitchIpNotEnough	The ip of vswitch1 not enough.
400	InvalidVSwitchId.SecondVswitchIpNotEnough	The ip of vswitch2 not enough.
400	InvalidVSwitchId.ZoneIdShouldDifferent	Two vSwitches should belong to different Availability Zones.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。