すべてのプロダクト
Search

このプロダクト

    VPN Gateway:CreateVpnGateway

    ドキュメントセンター

    VPN Gateway:CreateVpnGateway

    最終更新日:Oct 08, 2026

    VPN ゲートウェイを作成します。

    操作説明

    • VPN ゲートウェイを作成する前に、VPN ゲートウェイの使用制限を確認してください。詳細については、「VPN ゲートウェイの使用制限」を参照してください。

    • 一部のリージョンでは、VPN ゲートウェイインスタンスはデフォルトでデュアルトンネル IPsec-VPN 接続のみをサポートしています。これらのリージョンで CreateVpnGateway 操作を呼び出して VPN ゲートウェイインスタンスを作成する場合、必須パラメーターに加えて VSwitchId および DisasterRecoveryVSwitchId パラメーターを指定する必要があります。デュアルトンネル IPsec-VPN 接続をサポートするリージョンとゾーンの詳細については、「IPsec-VPN 接続のデュアルトンネルモードへのアップグレード」を参照してください。

    • CreateVpnGateway 操作は非同期です。システムはインスタンス ID を返しますが、VPN ゲートウェイはまだ作成されておらず、作成タスクはバックグラウンドで実行中です。 DescribeVpnGateway 操作を呼び出して、VPN ゲートウェイの作成ステータスをクエリできます。

      • VPN ゲートウェイが provisioning 状態の場合、VPN ゲートウェイは作成中です。

      • VPN ゲートウェイがアクティブな状態の場合、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 ゲートウェイが属するリージョン。 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 (従量課金)。

    Example value for the China site: PREPAY. Example value for the international site: 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

    任意

    同時 SSL-VPN 接続の最大値。有効な値: 5 (デフォルト)、10、20、50、100、200、500、1000。

    5
    VSwitchId

    string

    任意

    VPN ゲートウェイインスタンスに関連付ける vSwitch の ID。

    • デュアルトンネル IPsec-VPN 接続をサポートするリージョンでは、このパラメーターは必須です。vSwitch を指定し、DisasterRecoveryVSwitchId パラメーターも指定する必要があります。

    • シングルトンネル IPsec-VPN 接続をサポートするリージョンでは、vSwitch を指定しない場合、システムは VPC 内の vSwitch を自動的に選択します。

    vsw-bp1j5miw2bae9s2vt****
    VpnType

    string

    任意

    VPN ゲートウェイのタイプ。有効な値:

    • Normal (デフォルト): 法線。

    Normal
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用されるクライアントトークン。

    クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。

    説明

    このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は一意です。

    02fb3da4****
    NetworkType

    string

    任意

    VPN ゲートウェイのネットワークタイプ。有効な値:

    • public (デフォルト): インターネットパブリック VPN ゲートウェイ。

    • private: 非公開パブリック VPN ゲートウェイ。

    public
    DisasterRecoveryVSwitchId

    string

    任意

    VPN ゲートウェイインスタンスに関連付ける 2 番目の vSwitch の ID。

    • 現在のリージョンがデュアルトンネルモードの IPsec-VPN 接続をサポートしている場合、このパラメーターは必須です。

    • IPsec-VPN 接続のゾーンレベルのディザスタリカバリを実装するには、VPN ゲートウェイインスタンスが関連付けられている 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. プライベートネットワークタイプの 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. プライマリ 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 の作成時に指定する 2 つの vSwitch は、異なるゾーンに属している必要があります。
    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. 指定された vSwitch がリージョンに存在しません。
    400 InvalidVSwitchId.SecondVswitchNotSupport The zone of the DisasterRecoveryVSwitch does not support creating a ha-tunnel VPN. セカンダリ vSwitch が存在するゾーンはサポートされていません。
    404 InvalidRegionId.NotFound The specified region is not found during access authentication. 指定された RegionId は存在しません。このサービスが当該リージョンで利用可能かどうかを確認してください。

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

    変更履歴

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