トランジットルーターインスタンスに関連付ける IPsec-VPN 接続を作成します。
操作説明
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
vpc:CreateVpnAttachment |
create |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
IPsec-VPN 接続のリージョン ID。 DescribeRegions オペレーションを呼び出して、リージョン ID を照会できます。 |
cn-hangzhou |
| Name |
string |
任意 |
IPsec-VPN 接続の名前。 |
nametest |
| CustomerGatewayId |
string |
任意 |
カスタマーゲートウェイの ID。 |
cgw-p0w2jemrcj5u61un8**** |
| NetworkType |
string |
任意 |
IPsec-VPN 接続のネットワークタイプ。有効な値:
|
public |
| LocalSubnet |
string |
必須 |
オンプレミスデータセンターと通信する必要がある VPC 側の CIDR ブロック。位相 2 ネゴシエーションに使用されます。 複数の CIDR ブロックを指定する場合は、カンマ (,) で区切ります。例: 192.168.1.0/24,192.168.2.0/24。 IPsec-VPN 接続のルーティングモードの説明:
|
10.1.1.0/24,10.1.2.0/24 |
| RemoteSubnet |
string |
必須 |
VPC と通信する必要があるオンプレミスデータセンターの CIDR ブロック。位相 2 ネゴシエーションに使用されます。 複数の CIDR ブロックを指定する場合は、カンマ (,) で区切ります。例: 192.168.3.0/24,192.168.4.0/24。 IPsec-VPN 接続のルーティングモードの説明:
|
10.1.3.0/24,10.1.4.0/24 |
| EffectImmediately |
boolean |
任意 |
IPsec-VPN 接続設定を即時に有効にするかどうかを指定します。有効な値:
|
false |
| IkeConfig |
string |
任意 |
このパラメーターは、シングルトンネルモードで IPsec-VPN 接続を作成する場合にサポートされます。 フェーズ 1 ネゴシエーション設定:
|
{"Psk":"1234****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"47.XX.XX.1","RemoteId":"47.XX.XX.2"} |
| IpsecConfig |
string |
任意 |
このパラメーターは、シングルトンネルモードで IPsec-VPN 接続を作成する場合にサポートされます。 位相 2 ネゴシエーションの設定:
|
{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400} |
| BgpConfig |
string |
任意 |
このパラメーターは、シングルトンネルモードで IPsec-VPN 接続を作成する場合にサポートされます。 BGP 構成:
説明
|
{"EnableBgp":"true","LocalAsn":"45104","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"} |
| HealthCheckConfig |
string |
任意 |
このパラメーターは、シングルトンネルモードで IPsec-VPN 接続を作成する場合にサポートされます。 |
{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3","Policy": "revoke_route"} |
| AutoConfigRoute |
boolean |
任意 |
ルートを自動的に設定するかどうかを指定します。有効な値:
|
true |
| EnableDpd |
boolean |
任意 |
このパラメーターは、シングルトンネルモードで IPsec-VPN 接続を作成する場合にサポートされます。 Dead Peer Detection (DPD) 機能を有効にするかどうかを指定します。有効な値:
|
true |
| EnableNatTraversal |
boolean |
任意 |
このパラメーターは、シングルトンネルモードで IPsec-VPN 接続を作成する場合にサポートされます。 NAT 越えを有効にするかどうかを指定します。有効な値:
|
true |
| RemoteCaCert |
string |
任意 |
ピアの CA 証明書。 |
-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用できます。 説明
このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は異なります。 |
123e4567-e89b-12d3-a456-4266**** |
| Tags |
array<object> |
任意 |
IPsec-VPN 接続に追加するタグのリスト。 |
|
|
object |
任意 |
タグ情報のフォーマット。 |
||
| Key |
string |
任意 |
タグキー。この値は空文字列にできません。 タグキーの長さは最大 64 文字です。 一度に最大 20 個のタグキーを指定できます。 |
TagKey |
| Value |
string |
任意 |
タグ値。 |
TagValue |
| ResourceGroupId |
string |
任意 |
IPsec-VPN 接続が属するリソースグループの ID。 |
rg-acfmzs372yg**** |
| TunnelOptionsSpecification |
array<object> |
任意 |
トンネルを設定します。
|
|
|
array<object> |
任意 |
トンネル構成情報のフォーマット。 |
||
| CustomerGatewayId |
string |
任意 |
トンネルに関連付けられたカスタマーゲートウェイの ID。 |
cgw-p0w2jemrcj5u61un8**** |
| EnableDpd |
boolean |
任意 |
トンネルの Dead Peer Detection (DPD) 特徴を有効にするかどうかを指定します。有効な値: |
true |
| EnableNatTraversal |
boolean |
任意 |
トンネルの NAT 越えを有効にするかどうかを指定します。有効な値:
|
true |
| TunnelIndex |
integer |
任意 |
トンネルの作成順序。 |
1 |
| TunnelBgpConfig |
object |
任意 |
トンネルの BGP 構成。 |
|
| LocalAsn |
integer |
任意 |
トンネルの Alibaba Cloud 側の自律システム番号 (ASN)。有効な値: 1 ~ 4294967295。デフォルト値: 45104。 |
65530 |
| LocalBgpIp |
string |
任意 |
トンネルの Alibaba Cloud 側の BGP アドレス。このアドレスは BGP CIDR ブロック内の IP アドレスです。 |
169.254.10.1 |
| TunnelCidr |
string |
任意 |
トンネルの BGP CIDR ブロック。CIDR ブロックは 169.254.0.0/16 の範囲内であり、プレフィックス長が 30 である必要があります。CIDR ブロックとして 169.254.0.0/30、169.254.1.0/30、169.254.2.0/30、169.254.3.0/30、169.254.4.0/30、169.254.5.0/30、169.254.6.0/30、または 169.254.169.252/30 は指定できません。 |
169.254.10.0/30 |
| TunnelIkeConfig |
object |
任意 |
位相 1 ネゴシエーションの構成。 |
|
| IkeAuthAlg |
string |
任意 |
位相 1 ネゴシエーションの認証アルゴリズム。有効な値: md5、sha1、sha256、sha384、sha512。デフォルト値: sha1。 |
sha1 |
| IkeEncAlg |
string |
任意 |
位相 1 ネゴシエーションの暗号化アルゴリズム。有効な値: aes、aes192、aes256、des、3des。デフォルト値: aes。 |
aes |
| IkeLifetime |
integer |
任意 |
位相 1 でネゴシエートされるセキュリティアソシエーション (SA) の有効期間。単位: 秒。 有効な値: 0 ~ 86400。デフォルト値: 86400。 |
86400 |
| IkeMode |
string |
任意 |
IKE バージョンのネゴシエーションモード。有効な値: main または aggressive。デフォルト値: main。
|
main |
| IkePfs |
string |
任意 |
第 1 位相のネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズム。デフォルト値: group2。 |
group2 |
| IkeVersion |
string |
任意 |
IKE プロトコルのバージョン。有効な値: ikev1 または ikev2。デフォルト値: ikev2。 IKEv2 は IKEv1 と比較して、SA ネゴシエーションプロセスを簡素化し、マルチ CIDR ブロックのシナリオに対するサポートが強化されています。 |
ikev2 |
| LocalId |
string |
任意 |
トンネルの Alibaba Cloud 側の識別子で、位相 1 ネゴシエーションに使用されます。値の長さは最大 100 文字で、スペースを含めることはできません。デフォルト値はトンネルの IP アドレスです。 |
47.XX.XX.1 |
| Psk |
string |
任意 |
事前共有鍵。トンネルとトンネルピア間の身分認証に使用されます。
説明
トンネルとトンネルピアの事前共有鍵は同じである必要があります。異なる場合、トンネルを確立できません。 |
123456**** |
| RemoteId |
string |
任意 |
トンネルピアの識別子で、位相 1 ネゴシエーションに使用されます。値の長さは最大 100 文字で、スペースを含めることはできません。デフォルト値はトンネルに関連付けられたカスタマーゲートウェイの IP アドレスです。 |
47.XX.XX.2 |
| TunnelIpsecConfig |
object |
任意 |
位相 2 ネゴシエーションの構成。 |
|
| IpsecAuthAlg |
string |
任意 |
位相 2 ネゴシエーションの認証アルゴリズム。 |
sha1 |
| IpsecEncAlg |
string |
任意 |
位相 2 ネゴシエーションの暗号化アルゴリズム。有効な値: aes、aes192、aes256、des、3des。デフォルト値: aes。 |
aes |
| IpsecLifetime |
integer |
任意 |
位相 2 でネゴシエートされた SA の有効時間。単位: 秒。 |
86400 |
| IpsecPfs |
string |
任意 |
第 2 位相のネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズム。デフォルト値: group2。 |
group2 |
| EnableTunnelsBgp |
boolean |
任意 |
このパラメーターは、デュアルトンネルモードで IPsec-VPN 接続を作成する場合にサポートされます。 |
false |
| DryRun |
boolean |
任意 |
ドライランを実行するかどうかを指定します。有効な値:
|
false |
| TunnelBandwidth |
string |
任意 |
単一 VPN トンネルの帯域幅仕様。有効な値: |
標準 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
88187252-0E26-3C4D-9D1D-32A04454EBBA |
| VpnConnectionId |
string |
IPsec-VPN 接続の ID。 |
vco-p0wb09rama8qwwgfn**** |
| Name |
string |
IPsec-VPN 接続の名前。 |
nametest |
| CreateTime |
integer |
IPsec-VPN 接続が作成されたタイムスタンプ。単位: ミリ秒。 このタイムスタンプは UNIX タイムスタンプ形式で、1970 年 1 月 1 日 00:00:00 (UTC) から IPsec-VPN 接続が作成された時刻までに経過したミリ秒の総数を表します。 |
1658201810000 |
| Code |
string |
現在のタスクによって返される状態コード。値が 200 の場合、タスクが成功したことを示します。 |
200 |
| Message |
string |
現在のタスクによって返されるメッセージ。 |
successful |
| Success |
boolean |
現在のタスクが正常に実行されたかどうかを示します。
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "88187252-0E26-3C4D-9D1D-32A04454EBBA",
"VpnConnectionId": "vco-p0wb09rama8qwwgfn****",
"Name": "nametest",
"CreateTime": 1658201810000,
"Code": "200",
"Message": "successful",
"Success": true
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Resource.QuotaFull | The quota of resource is full | |
| 400 | InvalidVpnConnection.AlreadyExists | Vpn connection already exists. | |
| 400 | VpnRouteEntry.AlreadyExists | The specified route entry is already exist. | ルートはすでに存在します。 |
| 400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | 指定されたクライアント IP プールが VPN 接続または SSL サーバーと競合しています。 |
| 400 | NotSupportVpnConnectionParameter.IpsecPfs | The specified vpn connection ipsec Ipsec Pfs is not support. | IPsec-VPN 接続で指定された PFS パラメーターはサポートされていません。 |
| 400 | NotSupportVpnConnectionParameter.IpsecAuthAlg | The specified vpn connection ipsec Auth Alg is not support. | IPsec-VPN 接続で指定された認証アルゴリズムはサポートされていません。 |
| 400 | VpnRouteEntry.BackupRoute | Validate backup route entry failed. | アクティブ/スタンバイルートエントリの検証が失敗しました。 |
| 400 | VpnRouteEntry.InvalidWeight | Invalid route entry weight value. | ルートの重み値が無効です。 |
| 400 | InvalidParameter.VpnConnectionName | The specified vpn connection name is invalid. | 指定された VPN 接続名が無効です。 |
| 400 | QuotaExceeded.PolicyBasedRoute | The maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s. | ポリシーベースルートの数が上限に達しました。現在の数は %s で、%s 個のルートが作成され、上限は %s です。 |
| 400 | MissingParameter.TunnelCidr | The parameter TunnelCidr is mandatory when BGP is enabled. | BGP が有効な場合、トンネル CIDR ブロックパラメーターは必須です。 |
| 400 | OperationUnsupported.EnableBgp | Current region does not support enable BGP. | このリージョンでは BGP の有効化はサポートされていません。 |
| 400 | MissingParam.CustomerGatewayAsn | Asn of customer gateway is mandatory when BGP is enabled. | BGP が有効な場合、カスタマーゲートウェイの自律システム番号を空にすることはできません。 |
| 400 | IllegalParam.LocalAsn | The specified LocalAsn is invalid. | LocalAsn パラメーターが無効です。 |
| 400 | InvalidParameter.BgpConfig | The specified BgpConfig is invalid. | 指定された BGP 構成が無効です。 |
| 400 | IllegalParam.EnableBgp | VPN connection must enable BGP when VPN gateway has enabled BGP. | VPN ゲートウェイで BGP が有効になっている場合、VPN 接続でも BGP を有効にする必要があります。 |
| 400 | IllegalParam.TunnelCidr | The specified TunnelCidr is invalid. | TunnelCidr パラメーターが無効です。 |
| 400 | InvalidLocalBgpIp.Malformed | The specified LocalBgpIp is malformed. | 指定されたローカル BGP IP アドレスが無効です。 |
| 400 | IllegalParam.LocalBgpIp | The specified LocalBgpIp is invalid. | ローカル BGP アドレスが無効です。 |
| 400 | IllegalParam.LocalSubnet | The specified "LocalSubnet" (%s) is invalid. | ローカル CIDR ブロック (%s) が無効です。 |
| 400 | IllegalParam.RemoteSubnet | The specified "RemoteSubnet" (%s) is invalid. | ピア CIDR ブロック (%s) が無効です。 |
| 400 | OperationFailed.MissCertificate | The VPN connecton has not associated any certificates. | 現在の VPN 接続は証明書に関連付けられていません。 |
| 400 | MissingParam.RemoteId | The remote ID is mandatory when creating national standard VPN connection. | ShangMi (SM) VPN 接続を作成する場合、リモート ID は必須です。 |
| 400 | CustomerGateway.ConflictRouteEntry | The specified customer gateway has conflict with route entry. | 現在のカスタマーゲートウェイとルートの間に競合が存在します。 |
| 400 | VpnTask.CONFLICT | Vpn task has conflict. | VPN 操作の競合が存在します。後でもう一度お試しください。 |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | タグのリソースが重複しています。 |
| 400 | OperationFailed.NoAvailableAmount | The available amount of your account is less than 0, please recharge before attempting to purchase. | アカウント残高が 0 未満です。アカウントに入金してから再試行してください。 |
| 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 | InvalidTunnelCidr.Malformed | The specified TunnelCidr is malformed. | 指定されたトンネル CIDR ブロックが無効です。 |
| 400 | CustomerGateway.ConflictVpnIp | The customer gateway associated with the IPSec connection should not have the same IP address as the VPN gateway. | カスタマーゲートウェイの IP アドレスが VPN ゲートウェイの IP アドレスと競合しています。 |
| 400 | MissingParameter.TunnelOptionsSpecification | The required parameters are missing when creating a tunnel for dual-tunnel VPN. | デュアルトンネル VPN 接続のトンネル作成時に必須パラメーターがありません。 |
| 400 | CreateDbrRoutesQuotaFull.QuotaFull | The number of created destination routes exceeds the quota limit. | 送信先ルートの数がクォータ制限を超えています。 |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun 検証が有効です。 |
| 400 | VpnConnection.InvalidCreateTunnelOptions | The master and slave tunnels must be created at the same time. | アクティブなトンネルとスタンバイトンネルは同じ時間に作成する必要があります。 |
| 400 | OperationUnsupported.LargeTunnelBandwidth | Large tunnelBandwidth VpnAttachment is unsupported. | large 帯域幅の VpnAttachment の作成はサポートされていません。 |
| 400 | IllegalParam.TunnelBandwidth | TunnelBandwidth is illegal. | TunnelBandwidth パラメーターが無効です。 |
| 400 | EncAlgInvalid.DesIncompatible | Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm. | DES および 3DES アルゴリズムは、IKE 暗号化アルゴリズムまたは IPsec 暗号化アルゴリズムにおけるマルチアルゴリズム互換性をサポートしていません。 |
| 400 | OperationFailed.OpenCdtServiceFirst | The operation is failed because of %s. | 指定された課金タイプでは Cloud Data Transfer (CDT) の有効化が必要です。CDT を有効化してからもう一度お試しください。請求書を確認してください。 |
| 400 | IkeVersionInvalid.GcmIncompatible | Ikev1 does not support IkeEncAlg of gcm16. | IKEv1 は、IKE 暗号化アルゴリズムとして GCM-128 アルゴリズムのみを設定することをサポートしていません。 |
| 400 | CustomerGateway.AsnNotConfigured | ASN of CustomerGateway is required when enabling BGP on an IPSec connection. | IPsec-VPN 接続で BGP が有効な場合、カスタマーゲートウェイに ASN を設定する必要があります。 |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. | EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。 |
| 404 | InvalidCustomerGatewayInstanceId.NotFound | The specified customer gateway instance id does not exist. | 指定されたカスタマーゲートウェイインスタンスが存在しません。カスタマーゲートウェイインスタンス ID が正しいかどうかを確認してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。