すべてのプロダクト
Search
ドキュメントセンター

VPN Gateway:ModifyVpnAttachmentAttribute

最終更新日:Apr 27, 2026

IPsec 接続の構成を変更します。

操作説明

  • デュアルトンネルモードの IPsec 接続を変更する場合、必須リクエストパラメーターに加えて、以下のパラメーターを設定できます:ClientTokenNameLocalSubnetRemoteSubnetEffectImmediatelyAutoConfigRouteTunnelOptionsSpecification 配列、および EnableTunnelsBgp

  • シングルトンネルモードの IPsec 接続を変更する場合、必須リクエストパラメーターに加えて、以下のパラメーターを設定できます:ClientTokenNameLocalSubnetRemoteSubnetEffectImmediatelyIkeConfigIpsecConfigHealthCheckConfigAutoConfigRouteEnableDpdEnableNatTraversalBgpConfig、および CustomerGatewayId

  • ModifyVpnAttachmentAttribute は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。タスクのステータスを確認するには、DescribeVpnConnection 操作を呼び出してください。

    • IPsec 接続のステータスが updating の場合、IPsec 接続が変更中です。

    • IPsec 接続のステータスが attached の場合、IPsec 接続の変更が完了しています。

  • 指定された期間内に ModifyVpnAttachmentAttribute を同時に呼び出すことはできません。

  • ModifyVpnAttachmentAttribute を使用して、IPsec 接続のゲートウェイタイプを変更することはできません。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

IPsec 接続が確立されているリージョンの ID です。

最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出してください。

cn-hangzhou

VpnConnectionId

string

必須

IPsec 接続の ID です。

vco-p0w5112fgnl2ihlmf****

Name

string

任意

IPsec 接続の名前です。

名前は 1~100 文字で指定し、先頭を http:// または https:// にすることはできません。

nametest

LocalSubnet

string

任意

VPC とデータセンター間で通信する VPC の CIDR ブロックです。この CIDR ブロックはフェーズ 2 ネゴシエーションで使用されます。

複数の CIDR ブロックを指定する場合は、カンマ (,) で区切ります。例:192.168.1.0/24,192.168.2.0/24。

以下のルーティングモードがサポートされています。

  • LocalSubnet および RemoteSubnet を 0.0.0.0/0 に設定した場合、IPsec 接続のルーティングモードは「宛先ルーティングモード」になります。

  • LocalSubnet および RemoteSubnet を特定の CIDR ブロックに設定した場合、IPsec 接続のルーティングモードは「保護対象データフロー」になります。

10.1.1.0/24,10.1.2.0/24

RemoteSubnet

string

任意

VPC と通信するデータセンター側の CIDR ブロックです。この CIDR ブロックはフェーズ 2 ネゴシエーションで使用されます。

複数の CIDR ブロックを指定する場合は、カンマ (,) で区切ります。例:192.168.3.0/24,192.168.4.0/24。

以下のルーティングモードがサポートされています。

  • LocalSubnet および RemoteSubnet を 0.0.0.0/0 に設定した場合、IPsec 接続のルーティングモードは「宛先ルーティングモード」になります。

  • LocalSubnet および RemoteSubnet を特定の CIDR ブロックに設定した場合、IPsec 接続のルーティングモードは「保護対象データフロー」になります。

10.1.3.0/24,10.1.4.0/24

EffectImmediately

boolean

任意

構成適用後に直ちに IPsec ネゴシエーションを開始するかどうかを指定します。有効値:

  • true:構成完了後に直ちに IPsec ネゴシエーションを開始します。

  • false:インバウンドトラフィックを検出したときに IPsec ネゴシエーションを開始します。

false

IkeConfig

string

任意

このパラメーターは、シングルトンネルモードの IPsec 接続の構成を変更する場合にサポートされます。

フェーズ 1 ネゴシエーションの構成:

  • IkeConfig.Psk:Alibaba Cloud の IPsec 接続とオンプレミスデータセンター間で身分認証に使用される事前共有鍵です。

    • 鍵の長さは 1~100 文字で、数字および英字を含めることができますが、スペースを含めることはできません。~!`@#$%^&*()_-+={}[]|;:',.<>/?

    • 事前共有鍵を指定しない場合、システムはランダムに 16 桁の文字列を事前共有鍵として生成します。自動生成された事前共有鍵を照会するには、DescribeVpnConnection 操作を呼び出してください。

    説明

    IPsec 接続の事前共有鍵は、オンプレミスデータセンターの認証キーと一致している必要があります。一致しない場合、オンプレミスデータセンターと VPN ゲートウェイ間の接続を確立できません。

  • IkeConfig.IkeVersion:インターネットキー交換 (IKE) プロトコルのバージョンです。有効値:ikev1 および ikev2

  • IkeConfig.IkeMode:ネゴシエーションモードです。有効値:main および aggressive

  • IkeConfig.IkeEncAlg: フェーズ 1 ネゴシエーションで使用される暗号化アルゴリズムです。有効値:aesaes192aes256des、および 3des

  • IkeConfig.IkeAuthAlg:フェーズ 1 ネゴシエーションで使用される認証アルゴリズムです。有効値:md5sha1sha256sha384、および sha512

  • IkeConfig.IkePfs:フェーズ 1 ネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズムです。有効値:group1group2group5、および group14

  • IkeConfig.IkeLifetime:フェーズ 1 ネゴシエーションの結果として決定される SA の有効期間です。単位:秒。有効値:086400

  • IkeConfig.LocalId:Alibaba Cloud 側の識別子です。識別子の長さは 100 文字以内で、スペースを含めることはできません。

  • IkeConfig.RemoteId:データセンター側の識別子です。識別子の長さは 100 文字以内で、スペースを含めることはできません。

{"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 接続の構成を変更する場合にサポートされます。

フェーズ 2 ネゴシエーションの構成:

  • IpsecConfig.IpsecEncAlg: フェーズ 2 ネゴシエーションで使用される暗号化アルゴリズムです。有効値:aesaes192aes256des、および 3des

  • IpsecConfig. IpsecAuthAlg: フェーズ 2 ネゴシエーションで使用される認証アルゴリズムです。有効値:md5sha1sha256sha384、および sha512

  • IpsecConfig. IpsecPfs: フェーズ 2 ネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズムです。有効値:disabledgroup1group2group5、および group14

  • IkeConfig.IkeLifetime:フェーズ 2 ネゴシエーションによって決定される SA の有効期間です。単位:秒。有効値:086400

{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}

BgpConfig

string

任意

このパラメーターは、シングルトンネルモードの IPsec 接続の構成を変更する場合にサポートされます。

BGP 構成:

  • BgpConfig.EnableBgp:BGP を有効にするかどうかを指定します。有効値:

    • true

    • false

  • BgpConfig.LocalAsn:Alibaba Cloud 側の自律システム番号 (ASN) です。有効値:14294967295

    2 つのセグメントに分割して入力できます。各セグメントは 16 ビット長で、10 進数形式で入力します。

    たとえば、123.456 と入力すると、ASN は 8061384 になります。ASN は次の数式で計算されます:123 × 65536 + 456 = 8061384。

  • BgpConfig.TunnelCidr:IPsec トンネルの CIDR ブロックです。CIDR ブロックは 169.254.0.0/16 内に含まれる必要があり、マスク長は 30 ビットである必要があります。また、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 は使用できません。

  • LocalBgpIp:Alibaba Cloud 側の BGP アドレスです。IPsec トンネルの CIDR ブロック内に含まれる IP アドレスである必要があります。

説明
  • BGP 構成を追加する前に、BGP の動作原理および制限事項について理解しておくことを推奨します。詳細については、「BGP 動的ルーティングの設定」をご参照ください。

  • Alibaba Cloud との BGP 接続を確立する際は、プライベート ASN を使用することを推奨します。プライベート ASN の範囲については、関連ドキュメントをご参照ください。

{"EnableBgp":"true","LocalAsn":"45104","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"}

HealthCheckConfig

string

任意

このパラメーターは、シングルトンネルモードの IPsec 接続の構成を変更する場合にサポートされます。

ヘルスチェック設定:

  • HealthCheckConfig.enable:ヘルスチェック機能を有効にするかどうかを指定します。有効値:

    • true

    • false

  • HealthCheckConfig.dip:ヘルスチェック用に設定された宛先 IP アドレスです。IPsec 接続を通じて VPC がアクセスできるデータセンターの IP アドレスを指定します。

  • HealthCheckConfig.sip:ヘルスチェック用に設定されたソース IP アドレスです。IPsec 接続を通じてデータセンターがアクセスできる VPC の IP アドレスです。

  • HealthCheckConfig.interval:2 回のヘルスチェック間の間隔です。単位:秒。

  • HealthCheckConfig.retry: ヘルスチェックの最大リトライ回数です。

  • HealthCheckConfig.Policy:ヘルスチェック失敗時にアドバタイズされたルートを取り下げるかどうかを指定します。有効値:

    • revoke_route

    • reserve_route

{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3","Policy": "revoke_route"}

AutoConfigRoute

boolean

任意

ルートを自動的に構成するかどうかを指定します。有効値:

  • true

  • false

true

EnableDpd

boolean

任意

このパラメーターは、シングルトンネルモードの IPsec 接続の構成を変更する場合にサポートされます。

ピア生存確認 (DPD) を有効にするかどうかを指定します。有効値:

  • true:DPD を有効にします。IPsec 接続のイニシエーターは DPD パケットを送信してピアの存在と可用性を確認します。指定された時間内にピアからフィードバックが得られない場合、接続は失敗し、ISAKMP SA および IPsec SA ならびにセキュリティトンネルが削除されます。

  • false:DPD を無効にします。IPsec 接続のイニシエーターは DPD パケットを送信しません。

true

EnableNatTraversal

boolean

任意

このパラメーターは、シングルトンネルモードの IPsec 接続の構成を変更する場合にサポートされます。

NAT 越えを有効にするかどうかを指定します。有効値:

  • true:NAT 越えを有効にします。NAT 越えを有効にすると、イニシエーターは IKE ネゴシエーション中に UDP ポートをチェックせず、IPsec 接続トンネルに沿って NAT ゲートウェイデバイスを自動的に検出できます。

  • false:NAT 越えを無効にします。

true

RemoteCaCert

string

任意

商密 (SM) VPN ゲートウェイを使用して IPsec 接続を作成する場合のピア CA 証明書です。

-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----

ClientToken

string

任意

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

クライアント側でトークンを生成できますが、異なるリクエスト間でトークンが一意になるようにする必要があります。トークンには ASCII 文字のみを使用できます。

説明

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

123e4567-e89b-12d3-a456-4266****

NetworkType

string

任意

IPsec 接続のネットワークタイプです。有効値:

  • public:インターネット経由の暗号化接続

  • private:プライベートネットワーク経由の暗号化接続

public

CustomerGatewayId

string

任意

IPsec 接続に関連付けるカスタマーゲートウェイです。

説明

このパラメーターは、シングルトンネル IPsec 接続でのみサポートされます。

cgw-p0w2jemrcj5u61un8****

TunnelOptionsSpecification

array<object>

任意

トンネル構成です。

デュアルトンネルモードの IPsec 接続の構成を変更する場合、TunnelOptionsSpecification 配列内でパラメーターを指定できます。これにより、IPsec 接続の 2 つのトンネルの構成を変更できます。

array<object>

任意

トンネル構成です。

TunnelId

string

任意

トンネル ID です。

tun-0jod7plwf2a0o9lvu****

CustomerGatewayId

string

任意

トンネルに関連付けられたカスタマーゲートウェイの ID です。

説明

このパラメーターは、デュアルトンネル IPsec 接続でのみサポートされます。

cgw-p0w2jemrcj5u61un8****

TunnelIndex

integer

任意

トンネル作成順序です。

  • 1:トンネル 1

  • 2:トンネル 2

1

EnableDpd

boolean

任意

トンネルに対してピア生存確認 (DPD) 機能を有効にするかどうかを指定します。有効値:

  • true:DPD を有効にします。IPsec 接続のイニシエーターは DPD パケットを送信してピアの存在と可用性を確認します。指定された時間内にピアからフィードバックが得られない場合、接続は失敗し、ISAKMP SA および IPsec SA ならびにセキュリティトンネルが削除されます。

  • false:DPD を無効にします。IPsec 接続のイニシエーターは DPD パケットを送信しません。

true

EnableNatTraversal

boolean

任意

トンネルに対して NAT 越えを有効にするかどうかを指定します。有効値:

  • true:NAT 越えを有効にします。NAT 越えを有効にすると、イニシエーターは IKE ネゴシエーション中に UDP ポートをチェックせず、IPsec 接続トンネルに沿って NAT ゲートウェイデバイスを自動的に検出できます。

  • false:NAT 越えを無効にします。

true

TunnelBgpConfig

object

任意

トンネルに BGP 構成を追加します。

説明

IPsec 接続で BGP を有効にする場合は、EnableTunnelsBgp パラメーターを true に設定する必要があります。

LocalAsn

integer

任意

Alibaba Cloud 側のトンネルの自律システム番号 (ASN) です。有効値:14294967295。デフォルト値:45104

説明

Alibaba Cloud との BGP 接続を確立する際は、プライベート ASN を使用することを推奨します。プライベート ASN の範囲については、関連ドキュメントをご参照ください。

65530

LocalBgpIp

string

任意

Alibaba Cloud 側のトンネルの BGP IP アドレスです。このアドレスは BGP CIDR ブロック内に含まれる IP アドレスです。

169.254.10.1

TunnelCidr

string

任意

トンネルの BGP CIDR ブロックです。CIDR ブロックは 169.254.0.0/16 内に含まれる必要があり、マスク長は 30 ビットである必要があります。また、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 は使用できません。

説明

IPsec 接続の 2 つのトンネルは、異なる CIDR ブロックを使用する必要があります。

169.254.10.0/30

TunnelIkeConfig

object

任意

フェーズ 1 ネゴシエーションの構成です。

IkeAuthAlg

string

任意

フェーズ 1 ネゴシエーションで使用される認証アルゴリズムです。有効値:md5sha1sha256sha384、および sha512

sha1

IkeEncAlg

string

任意

フェーズ 1 ネゴシエーションで使用される暗号化アルゴリズムです。有効値:aesaes192aes256des、および 3des

aes

IkeLifetime

integer

任意

フェーズ 1 ネゴシエーションの結果として決定される SA の有効期間です。単位:秒。

有効値:086400

86400

IkeMode

string

任意

Internet Key Exchange (IKE) のネゴシエーションモードです。有効値:main および aggressive

  • main: このモードは、ネゴシエーション中に高いセキュリティを提供します。

  • aggressive:このモードは高速で成功率が高いです。

main

IkePfs

string

任意

フェーズ 1 ネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズムです。有効値:group1group2group5、および group14

group2

IkeVersion

string

任意

Internet Key Exchange (IKE) プロトコルのバージョンです。有効値:ikev1 および ikev2

ikev1 と比較して、ikev2 は SA ネゴシエーションプロセスを簡素化し、複数の CIDR ブロックを持つシナリオへの対応を強化しています。

ikev2

LocalId

string

任意

フェーズ 1 ネゴシエーションで使用される Alibaba Cloud 側のトンネル識別子です。識別子の長さは 100 文字以内で、スペースを含めることはできません。

LocalId は完全修飾ドメイン名 (FQDN) をサポートします。FQDN を使用する場合は、ネゴシエーションモードを aggressive に設定することを推奨します。

47.XX.XX.1

Psk

string

任意

トンネルとトンネルピア間の身分認証に使用される事前共有鍵です。

  • 鍵の長さは 1~100 文字で、数字および英字を含めることができますが、スペースを含めることはできません。~!\`@#$%^&*()_-+={}[]|;:',.<>/?

  • 事前共有鍵を指定しない場合、システムはランダムに 16 桁の文字列を事前共有鍵として生成します。自動生成された事前共有鍵を照会するには、DescribeVpnAttachments 操作を呼び出してください。

説明

トンネルとトンネルピアは同じ事前共有鍵を使用する必要があります。一致しない場合、トンネルを確立できません。

123456****

RemoteId

string

任意

フェーズ 1 ネゴシエーションで使用されるトンネルピアの識別子です。識別子の長さは 100 文字以内で、スペースを含めることはできません。

RemoteId は FQDN をサポートします。FQDN を使用する場合は、ネゴシエーションモードを aggressive に設定することを推奨します。

47.XX.XX.2

TunnelIpsecConfig

object

任意

フェーズ 2 ネゴシエーションの構成です。

IpsecAuthAlg

string

任意

フェーズ 2 ネゴシエーションで使用される認証アルゴリズムです。

有効値:md5sha1sha256sha384、および sha512

sha1

IpsecEncAlg

string

任意

フェーズ 2 ネゴシエーションで使用される暗号化アルゴリズムです。有効値:aesaes192aes256des、および 3des

aes

IpsecLifetime

integer

任意

フェーズ 2 ネゴシエーションの結果として決定される SA の有効期間です。単位:秒。

有効値:086400

86400

IpsecPfs

string

任意

フェーズ 2 ネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズムです。

有効値:disabledgroup1group2group5、および group14

group2

EnableTunnelsBgp

boolean

任意

このパラメーターは、デュアルトンネル IPsec 接続の構成を変更する場合に指定できます。

トンネルに対して BGP 機能を有効にするかどうかを指定します。有効値:true および false

説明

BGP 構成を追加する前に、BGP の動作原理および制限事項について理解しておくことを推奨します。詳細については、「BGP 動的ルーティングの設定」をご参照ください。

false

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーターです。

VpnConnectionId

string

IPsec 接続の ID です。

vco-p0w5112fgnl2ihlmf****

CustomerGatewayId

string

IPsec 接続に関連付けられたカスタマーゲートウェイの ID です。

このパラメーターは、シングルトンネル IPsec 接続の場合にのみ返されます。

cgw-p0w2jemrcj5u61un8****

VpnGatewayId

string

IPsec 接続に関連付けられた VPN ゲートウェイの ID です。

vpn-not-exist:IPsec 接続は VPN ゲートウェイに関連付けられていません。

vpn-not-exist

Name

string

IPsec 接続の名前です。

nametest

Description

string

IPsec 接続の説明です。

desctest

LocalSubnet

string

オンプレミスデータセンターと通信する Alibaba Cloud 側の CIDR ブロック(VPC の CIDR ブロックなど)が必要です。

10.1.1.0/24,10.1.2.0/24

RemoteSubnet

string

Alibaba Cloud と通信するオンプレミスデータセンター側の CIDR ブロックが必要です。

10.1.3.0/24,10.1.4.0/24

IkeConfig

object

フェーズ 1 ネゴシエーションの構成です。

IkeConfig パラメーターは、シングルトンネル IPsec 接続の場合にのみ返されます。

Psk

string

Alibaba Cloud とデータセンター間の身分認証に使用される事前共有鍵を入力します。

説明

IPsec 接続の事前共有鍵は、オンプレミスデータセンターの認証キーと一致している必要があります。一致しない場合、オンプレミスデータセンターと Alibaba Cloud 間の接続を確立できません。

1234***

IkeVersion

string

Internet Key Exchange (IKE) プロトコルのバージョンです。

  • ikev1

  • ikev2

ikev1 と比較して、ikev2 は SA ネゴシエーションプロセスを簡素化し、複数の CIDR ブロックを持つシナリオへの対応を強化しています。

ikev1

IkeMode

string

Internet Key Exchange (IKE) ネゴシエーションモードです。

  • main: このモードは、ネゴシエーション中に高いセキュリティを提供します。

  • aggressive:このモードは高速で成功率が高いです。

main

IkeEncAlg

string

フェーズ 1 ネゴシエーションで使用される暗号化アルゴリズムです。

aes

IkeAuthAlg

string

フェーズ 1 ネゴシエーションで使用される認証アルゴリズムです。

sha1

IkePfs

string

フェーズ 1 ネゴシエーションで使用される DH キー交換アルゴリズムです。

group2

IkeLifetime

integer

フェーズ 1 ネゴシエーションによって決定される SA の有効期間です。単位:秒。

86400

LocalId

string

Alibaba Cloud 側の IPsec 接続識別子です。

47.XX.XX.1

RemoteId

string

データセンター側の IPsec 接続識別子です。

47.XX.XX.2

IpsecConfig

object

フェーズ 2 ネゴシエーションの構成です。

IpsecConfig パラメーターは、シングルトンネル IPsec 接続の場合にのみ返されます。

IpsecEncAlg

string

フェーズ 2 ネゴシエーションで使用される暗号化アルゴリズムです。

aes

IpsecAuthAlg

string

フェーズ 2 ネゴシエーションで使用される認証アルゴリズムです。

md5

IpsecPfs

string

フェーズ 2 ネゴシエーションで使用される DH キー交換アルゴリズムです。

group2

IpsecLifetime

integer

フェーズ 2 ネゴシエーションによって決定される SA の有効期間です。単位:秒。

86400

CreateTime

integer

IPsec 接続が確立された際に生成されたタイムスタンプです。単位:ミリ秒。

この値は UNIX タイムスタンプで、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。

1658201810000

EffectImmediately

boolean

構成適用後に直ちに IPsec ネゴシエーションを開始するかどうかを示します。有効値:

  • true

  • false

false

Status

string

IPsec 接続のステータスです。有効値:

  • ike_sa_not_established:フェーズ 1 ネゴシエーションに失敗しました。

  • ike_sa_established:フェーズ 1 ネゴシエーションに成功しました。

  • ipsec_sa_not_established:フェーズ 2 ネゴシエーションに失敗しました。

  • ipsec_sa_established:フェーズ 2 ネゴシエーションに成功しました。

ike_sa_not_established

VcoHealthCheck

object

IPsec 接続のヘルスチェック設定です。

VcoHealthCheck パラメーターは、シングルトンネル IPsec-VPC 接続の場合にのみ返されます。

Enable

string

IPsec 接続に対してヘルスチェック機能が有効かどうかを示します。有効値:

  • true

  • false

true

Sip

string

ヘルスチェックに使用されるソース IP アドレスです。

10.1.1.1

Dip

string

ヘルスチェックに使用される宛先 IP アドレスです。

192.168.1.1

Interval

integer

2 回のヘルスチェックリトライ間の間隔です。単位:秒。

3

Retry

integer

ヘルスチェックの最大リトライ回数です。

3

Policy

string

ヘルスチェック失敗時にアドバタイズされたルートを取り下げるかどうかを示します。有効値:

  • revoke_route:アドバタイズされたルートを取り下げます。

  • reserve_route:アドバタイズされたルートを取り下げません。

revoke_route

EnableDpd

boolean

IPsec 接続に対して DPD 機能が有効かどうかを示します。

  • true:機能が有効です。

  • false:機能が無効です。

このパラメーターは、シングルトンネル IPsec 接続の場合にのみ返されます。

true

EnableNatTraversal

boolean

IPsec 接続に対して NAT 越えを有効にするかどうかを指定します。

  • true:機能が有効です。

  • false:機能が無効です。

このパラメーターは、シングルトンネル IPsec 接続の場合にのみ返されます。

true

VpnBgpConfig

object

IPsec 接続の BGP 構成です。

VpnBgpConfig パラメーターは、シングルトンネル IPsec 接続の場合にのみ返されます。

EnableBgp

string

IPsec 接続に対して BGP が有効かどうかを示します。有効値:

  • true

  • false

true

TunnelCidr

string

IPsec トンネルの CIDR ブロックです。

169.254.11.0/30

LocalBgpIp

string

Alibaba Cloud 側の BGP IP アドレスです。

169.254.11.1

PeerBgpIp

string

データセンター側の BGP IP アドレスです。

169.254.11.2

LocalAsn

integer

Alibaba Cloud 側の自律システム番号 (ASN) です。

45104

PeerAsn

integer

データセンター側の自律システム番号 (ASN) です。

65535

Status

string

BGP のネゴシエーション状態です。有効値:

  • success:正常

  • false:異常

false

AttachType

string

IPsec 接続に関連付けられたリソースのタイプです。有効値:

  • CEN:IPsec 接続はトランジットルーターに関連付けられています。

  • VPNGW:IPsec 接続は VPN ゲートウェイに関連付けられています。

  • NO_ASSOCIATED:IPsec 接続はどのリソースにも関連付けられていません。

CEN

NetworkType

string

IPsec 接続のネットワークタイプです。有効値:

  • public:インターネット経由の暗号化接続

  • private:プライベートネットワーク経由の暗号化接続

public

AttachInstanceId

string

IPsec 接続に関連付けられたトランジットルーターが属する Cloud Enterprise Network (CEN) インスタンスの ID です。

cen-c2r3m3zxkumoqz****

Spec

string

IPsec 接続の帯域幅仕様です。

レスポンス内の M の値は Mbit/s を示します。

1000M

ResourceGroupId

string

IPsec 接続が属するリソースグループの ID です。

リソースグループを照会するには、ListResourceGroups 操作を呼び出してください。

rg-acfmzs372yg****

TunnelOptionsSpecification

array<object>

IPsec 接続のトンネル構成です。

TunnelOptionsSpecification パラメーターは、デュアルトンネル IPsec 接続の場合にのみ返されます。

array<object>

トンネル構成です。

CustomerGatewayId

string

トンネルに関連付けられたカスタマーゲートウェイの ID です。

cgw-p0w2jemrcj5u61un8****

EnableDpd

boolean

トンネルに対して DPD 機能が有効かどうかを示します。

  • true:機能が有効です。

  • false:機能が無効です。

true

EnableNatTraversal

boolean

トンネルに対して NAT 越え機能が有効かどうかを示します。有効値:

  • true:機能が有効です。

  • false:機能が無効です。

true

InternetIp

string

Alibaba Cloud 側の IP アドレスです。

47.XX.XX.66

Role

string

トンネルのロールです。有効値:

  • master:トンネルはアクティブトンネルです。

  • slave:トンネルはスタンバイトンネルです。

master

TunnelId

string

トンネル ID です。

tun-0jod7plwf2a0o9lvu****

TunnelIndex

integer

トンネル作成順序です。

  • 1:トンネル 1

  • 2:トンネル 2

1

State

string

トンネルのステータスです。有効値:

  • active:トンネルはアクティブです。

  • updating:トンネルは更新中です。

  • deleting: トンネルは削除中です。

active

TunnelBgpConfig

object

BGP 構成です。

LocalAsn

integer

Alibaba Cloud 側の自律システム番号 (ASN) です。

65530

LocalBgpIp

string

Alibaba Cloud 側のトンネルの BGP IP アドレスです。

169.254.10.1

PeerAsn

integer

トンネルピアの自律システム番号 (ASN) です。

65531

PeerBgpIp

string

トンネルピアの BGP IP アドレスです。

169.254.10.2

TunnelCidr

string

トンネルの BGP CIDR ブロックです。

169.254.10.0/30

TunnelIkeConfig

object

フェーズ 1 ネゴシエーションの構成です。

IkeAuthAlg

string

Internet Key Exchange (IKE) フェーズの認証アルゴリズムです。

sha1

IkeEncAlg

string

Internet Key Exchange (IKE) フェーズの暗号化アルゴリズムです。

aes

IkeLifetime

integer

Internet Key Exchange (IKE) フェーズの有効期間です。単位:秒。

86400

IkeMode

string

Internet Key Exchange (IKE) のネゴシエーションモードです。有効値:

  • main: このモードは、ネゴシエーション中に高いセキュリティを提供します。

  • aggressive:このモードは高速で成功率が高いです。

main

IkePfs

string

Internet Key Exchange (IKE) フェーズの Diffie-Hellman (DH) グループです。

group2

IkeVersion

string

Internet Key Exchange (IKE) プロトコルのバージョンです。

ikev2

LocalId

string

Alibaba Cloud 側のトンネル識別子です。

47.XX.XX.1

Psk

string

事前共有鍵です。

123456****

RemoteId

string

ピア識別子です。

47.XX.XX.2

TunnelIpsecConfig

object

フェーズ 2 ネゴシエーションの構成です。

IpsecAuthAlg

string

IPsec フェーズの認証アルゴリズムです。

sha1

IpsecEncAlg

string

IPsec フェーズの暗号化アルゴリズムです。

aes

IpsecLifetime

integer

IPsec フェーズの有効期間です。単位:秒。

86400

IpsecPfs

string

IPsec フェーズの DH グループです。

group2

EnableTunnelsBgp

boolean

トンネルに対してボーダーゲートウェイプロトコル (BGP) を有効にするかどうかを指定します。

  • true:機能が有効です。

  • false:機能が無効です。

このパラメーターは、デュアルトンネル IPsec 接続の場合にのみ返されます。

false

RequestId

string

リクエスト ID です。

35822A84-867F-3936-A2E6-A4C4E3ED11C0

成功レスポンス

JSONJSON

{
  "VpnConnectionId": "vco-p0w5112fgnl2ihlmf****",
  "CustomerGatewayId": "cgw-p0w2jemrcj5u61un8****",
  "VpnGatewayId": "vpn-not-exist",
  "Name": "nametest",
  "Description": "desctest",
  "LocalSubnet": "10.1.1.0/24,10.1.2.0/24",
  "RemoteSubnet": "10.1.3.0/24,10.1.4.0/24",
  "IkeConfig": {
    "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": {
    "IpsecEncAlg": "aes",
    "IpsecAuthAlg": "md5",
    "IpsecPfs": "group2",
    "IpsecLifetime": 86400
  },
  "CreateTime": 1658201810000,
  "EffectImmediately": false,
  "Status": "ike_sa_not_established",
  "VcoHealthCheck": {
    "Enable": "true",
    "Sip": "10.1.1.1",
    "Dip": "192.168.1.1",
    "Interval": 3,
    "Retry": 3,
    "Policy": "revoke_route"
  },
  "EnableDpd": true,
  "EnableNatTraversal": true,
  "VpnBgpConfig": {
    "EnableBgp": "true",
    "TunnelCidr": "169.254.11.0/30",
    "LocalBgpIp": "169.254.11.1",
    "PeerBgpIp": "169.254.11.2",
    "LocalAsn": 45104,
    "PeerAsn": 65535,
    "Status": "false"
  },
  "AttachType": "CEN",
  "NetworkType": "public",
  "AttachInstanceId": "cen-c2r3m3zxkumoqz****",
  "Spec": "1000M",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "TunnelOptionsSpecification": [
    {
      "CustomerGatewayId": "cgw-p0w2jemrcj5u61un8****",
      "EnableDpd": true,
      "EnableNatTraversal": true,
      "InternetIp": "47.XX.XX.66",
      "Role": "master",
      "TunnelId": "tun-0jod7plwf2a0o9lvu****",
      "TunnelIndex": 1,
      "State": "active",
      "TunnelBgpConfig": {
        "LocalAsn": 65530,
        "LocalBgpIp": "169.254.10.1",
        "PeerAsn": 65531,
        "PeerBgpIp": "169.254.10.2",
        "TunnelCidr": "169.254.10.0/30"
      },
      "TunnelIkeConfig": {
        "IkeAuthAlg": "sha1",
        "IkeEncAlg": "aes",
        "IkeLifetime": 86400,
        "IkeMode": "main",
        "IkePfs": "group2",
        "IkeVersion": "ikev2",
        "LocalId": "47.XX.XX.1",
        "Psk": "123456****",
        "RemoteId": "47.XX.XX.2"
      },
      "TunnelIpsecConfig": {
        "IpsecAuthAlg": "sha1",
        "IpsecEncAlg": "aes",
        "IpsecLifetime": 86400,
        "IpsecPfs": "group2"
      }
    }
  ],
  "EnableTunnelsBgp": false,
  "RequestId": "35822A84-867F-3936-A2E6-A4C4E3ED11C0"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 VpnConnection.Configuring The specified service is configuring.
400 VpnConnection.FinancialLocked The specified service is financial locked.
400 InvalidName The name is not valid
400 VpnRouteEntry.AlreadyExists The specified route entry is already exist.
400 VpnRouteEntry.Conflict The specified route entry has conflict.
400 NotSupportVpnConnectionParameter.IpsecPfs The specified vpn connection ipsec Ipsec Pfs is not support.
400 NotSupportVpnConnectionParameter.IpsecAuthAlg The specified vpn connection ipsec Auth Alg is not support.
400 VpnRouteEntry.BackupRoute Validate backup route entry failed.
400 VpnRouteEntry.InvalidWeight Invalid route entry weight value.
400 MissingParameter.TunnelCidr The parameter TunnelCidr is mandatory when BGP is enabled.
400 OperationUnsupported.EnableBgp Current region does not support enable BGP.
400 MissingParam.CustomerGatewayAsn Asn of customer gateway is mandatory when BGP is enabled.
400 IllegalParam.LocalAsn The specified LocalAsn is invalid.
400 IllegalParam.BgpConfig The specified BgpConfig is invalid.
400 IllegalParam.EnableBgp VPN connection must enable BGP when VPN gateway has enabled BGP.
400 IllegalParam.TunnelCidr The specified TunnelCidr is invalid.
400 InvalidLocalBgpIp.Malformed The specified LocalBgpIp is malformed.
400 IllegalParam.LocalBgpIp The specified LocalBgpIp is invalid.
400 IllegalParam.LocalSubnet The specified "LocalSubnet" (%s) is invalid.
400 IllegalParam.RemoteSubnet The specified "RemoteSubnet" (%s) is invalid.
400 CustomerGateway.ConflictRouteEntry The specified customer gateway has conflict with route entry.
400 IllegalParam.NetworkType The specified NetworkType (%s) is invalid.
400 InvalidTunnelCidr.Malformed The specified TunnelCidr is malformed.
400 VpnGateway.Configuring The specified service is configuring.
400 VpnTask.CONFLICT Vpn task has conflict.
400 ModifyIkeV1WithMultiRoutes.Invalid Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol.
400 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.
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.
400 CreateDbrRoutesQuotaFull.QuotaFull The number of created destination routes exceeds the quota limit.
400 CreatePbrRoutesQuotaFull.QuotaFull The number of policy routes exceeds the quota limit.
400 EncAlgInvalid.DesIncompatible Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm.
400 IkeVersionInvalid.GcmIncompatible Ikev1 does not support IkeEncAlg of gcm16.
400 CustomerGateway.ConflictVpnIp The specified customer gateway has conflict with vpn gateway ip.
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.
404 InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist.

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

変更履歴

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