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

VPN Gateway:DescribeVpnConnection

最終更新日:Apr 27, 2026

IPsec 接続の詳細情報をクエリします。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

Alibaba Cloud 側の CIDR ブロックです。

複数の CIDR ブロックはコンマ (,) で区切ります。

cn-hangzhou

VpnConnectionId

string

必須

リクエスト ID です。

vco-bp1bbi27hojx80nck****

レスポンスフィールド

フィールド

説明

object

IPsec 接続の ID です。

Status

string

データセンター側の CIDR ブロックです。

複数の CIDR ブロックはコンマ (,) で区切ります。

ike_sa_not_established

RemoteCaCertificate

string

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

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

EnableNatTraversal

boolean

IPsec 接続の名前です。

true

CreateTime

integer

IPsec 接続に対してデッドピア検出 (DPD) 機能が有効かどうかを示します。有効値は次のとおりです。

  • false

  • true

DPD 機能を有効化すると、IPsec 接続の開始側が DPD パケットを送信してピアの存在と可用性を確認します。指定された時間内にピアから応答がない場合、接続は失敗し、ISAKMP セキュリティアソシエーション (SA)、IPsec SA、および IPsec トンネルが削除されます。

1492753817000

EffectImmediately

boolean

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

true

VpnGatewayId

string

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

vpn-bp1q8bgx4xnkm2ogj****

LocalSubnet

string

IKE フェーズでのライフタイムです。単位:秒。

10.0.0.0/8

RequestId

string

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

F2310D45-BCF6-4E2E-9082-B4503844BA4C

VpnConnectionId

string

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

vco-bp1bbi27hojx80nck****

RemoteSubnet

string

IKE ネゴシエーションモードです。

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

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

192.168.0.0/16

CustomerGatewayId

string

IKE プロトコルのバージョンです。

  • ikev1

  • ikev2

IKEv1 と比較して、IKEv2 は SA ネゴシエーションプロセスを簡素化し、複数の CIDR ブロックを使用するシナリオにより適しています。

cgw-bp1mvj4g9kogwwcxk****

Name

string

IKE フェーズでのディフィー・ヘルマン (DH) グループです。

ipsec1

EnableDpd

boolean

事前共有鍵です。

true

IkeConfig

object

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

RemoteId

string

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

139.34.XX.XX

IkeLifetime

integer

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

86400

IkeEncAlg

string

IPsec フェーズでのライフタイムです。単位:秒。

aes

LocalId

string

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

116.28.XX.XX

IkeMode

string

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

main

IkeVersion

string

IPsec 接続に関するヘルスチェック情報です。

ikev1

IkePfs

string

ヘルスチェックの状態です。有効値は次のとおりです。

  • failed

  • success:正常

group2

Psk

string

宛先 IP アドレスです。

pgw6dy****

IkeAuthAlg

string

2 回の連続するヘルスチェック間の間隔です。単位:秒。

sha1

IpsecConfig

object

ヘルスチェックの最大再試行回数です。

IpsecAuthAlg

string

ソース IP アドレスです。

sha1

IpsecLifetime

integer

IPsec 接続に対してヘルスチェック機能が有効かどうかを示します。有効値は次のとおりです。

  • false

  • true

86400

IpsecEncAlg

string

ヘルスチェックが失敗した場合にアドバタイズされたルートを取り消すかどうかを示します。有効値は次のとおりです。

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

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

aes

IpsecPfs

string

IPsec 接続のボーダーゲートウェイプロトコル (BGP) 構成。

group2

VcoHealthCheck

object

BGP ルーティングプロトコルのネゴシエーション状態です。有効値は次のとおりです。

  • success:正常

  • failed

Status

string

ピアの BGP IP アドレスです。

failed

Dip

string

IPsec 接続の BGP CIDR ブロックです。CIDR ブロックは 169.254.0.0/16 の範囲内にあり、サブネットマスクの長さは 30 ビットである必要があります。

10.0.0.1

Interval

integer

BGP が有効かどうかを示します。有効値は次のとおりです。

  • true

  • false

3

Retry

integer

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

3

Sip

string

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

192.168.1.1

Enable

string

Alibaba Cloud 側の ASN です。

true

Policy

string

BGP ルーティングプロトコルの認証キーです。

revoke_route

VpnBgpConfig

object

IPsec 接続に関連付けられているリソースのタイプです。有効値は次のとおりです。

  • CEN:IPsec 接続が Cloud Enterprise Network (CEN) インスタンスのトランジットルーターに関連付けられていることを示します。

  • NO_ASSOCIATED:IPsec 接続がどのリソースにも関連付けられていないことを示します。

  • VPNGW:IPsec 接続が VPN ゲートウェイに関連付けられていることを示します。

Status

string

IPsec 接続のネットワークタイプです。有効値は次のとおりです。

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

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

success

PeerBgpIp

string

トランジットルーターが属する CEN インスタンスの ID です。

169.254.11.1

TunnelCidr

string

IPsec 接続の帯域幅仕様です。単位:Mbit/s

169.254.11.0/30

EnableBgp

string

IPsec 接続の関連付け状態です。有効値は次のとおりです。

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

  • init:IPsec 接続がどのリソースにも関連付けられておらず、初期化中です。

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

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

  • detaching:IPsec 接続がトランジットルーターからの関連付け解除中です。

  • financialLocked:IPsec 接続が支払い遅延によりロックされています。

  • provisioning:IPsec 接続が準備中です。

  • updating:IPsec 接続が更新中です。

  • Upgrading:IPsec 接続がスペックアップ中です。

  • deleted:IPsec 接続が削除されました。

true

LocalBgpIp

string

IPsec 接続がデプロイされているゾーンの ID です。

DescribeZones を呼び出して、ゾーン ID およびゾーン ID とゾーン名のマッピングをクエリできます。

169.254.11.2

PeerAsn

integer

IPsec 接続のゲートウェイ IP アドレスです。

65530

LocalAsn

integer

IPsec 接続が関連付けられているトランジットルーターの ID です。

65531

AuthKey

string

トランジットルーターの名前です。

AuthKey****

AttachType

string

IPsec 接続が別の Alibaba Cloud アカウントに属するトランジットルーターに関連付けられているかどうかを示します。有効値は次のとおりです。

  • true

  • false

CEN

NetworkType

string

IPsec 接続に追加されたタグのリストです。

public

AttachInstanceId

string

タグ情報です。

cen-lxxpbpalc776qz****

Spec

string

タグキーです。

1000M

State

string

タグ値です。

attached

ZoneNo

string

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

TunnelOptionsSpecification 内のパラメーターは、デュアルトンネルモードの IPsec 接続をクエリする場合にのみ返されます。

cn-hangzhou-h

InternetIp

string

トンネル構成です。

47.XX.XX.162

TransitRouterId

string

トンネル ID です。

tr-p0we2edef9qr44a85****

TransitRouterName

string

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

nametest

CrossAccountAuthorized

boolean

トンネルに対して DPD 機能が有効かどうかを示します。有効値は次のとおりです。

  • false

  • true

false

Tags

object

Tag

array<object>

トンネルに対して NAT 越えが有効かどうかを示します。有効値は次のとおりです。

  • false

  • true

object

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

Key

string

トンネルピアの CA 証明書です。

このパラメーターは、VPN ゲートウェイが ShangMi (SM) タイプの場合にのみ返されます。

TagKey

Value

string

トンネルロールです。有効値は次のとおりです。

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

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

TagValue

TunnelOptionsSpecification

object

TunnelOptions

array<object>

トンネル作成順序です。

  • 1:トンネル 1

  • 2:トンネル 2

説明

このパラメーターは、IPsec 接続がトランジットルーターに関連付けられている場合にのみ返されます。

array<object>

トンネルステータスです。有効値は次のとおりです。

  • active

  • updating

  • deleting

TunnelId

string

IPsec 接続の状態です。有効値は次のとおりです。

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

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

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

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

tun-opsqc4d97wni27****

CustomerGatewayId

string

BGP 構成です。

cgw-p0wy363lucf1uyae8****

EnableDpd

string

BGP のネゴシエーション状態です。有効値は次のとおりです。

  • success

  • false

true

EnableNatTraversal

string

Alibaba Cloud 側の ASN です。

true

InternetIp

string

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

47.21.XX.XX

RemoteCaCertificate

string

トンネルピアの ASN です。

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

Role

string

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

master

TunnelIndex

integer

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

1

State

string

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

active

Status

string

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

ipsec_sa_established

TunnelBgpConfig

object

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

BgpStatus

string

IKE フェーズでのライフタイムです。単位:秒。

success

LocalAsn

string

IKE ネゴシエーションモードです。

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

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

65530

LocalBgpIp

string

IKE フェーズでのディフィー・ヘルマン (DH) グループです。

169.254.10.1

PeerAsn

string

IKE プロトコルのバージョンです。

65531

PeerBgpIp

string

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

169.254.10.2

TunnelCidr

string

事前共有鍵です。

169.254.10.0/30

TunnelIkeConfig

object

トンネルピアの識別子です。

IkeAuthAlg

string

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

sha1

IkeEncAlg

string

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

aes

IkeLifetime

string

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

86400

IkeMode

string

IPsec フェーズでのライフタイムです。単位:秒。

main

IkePfs

string

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

group2

IkeVersion

string

トンネルがデプロイされているゾーンです。

DescribeZones を呼び出して、ゾーン ID をクエリできます。

ikev1

LocalId

string

トンネルに対して BGP が有効かどうかを示します。有効値は次のとおりです。

  • true

  • false

47.21.XX.XX

Psk

string

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

ListResourceGroups 操作を呼び出して、リソースグループ情報をクエリできます。

123456****

RemoteId

string

トンネルピアの識別子です。

47.42.XX.XX

TunnelIpsecConfig

object

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

IpsecAuthAlg

string

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

sha1

IpsecEncAlg

string

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

aes

IpsecLifetime

string

IPsec フェーズでのライフタイムです。単位:秒。

86400

IpsecPfs

string

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

group2

ZoneNo

string

トンネルゾーンです。

cn-hangzhou-i

EnableTunnelsBgp

boolean

トンネルに対して BGP が有効かどうかを示します。有効値は次のとおりです。

  • true

  • false

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

true

ResourceGroupId

string

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

ListResourceGroups 操作を呼び出して、リソースグループリストをクエリできます。

rg-acfmzs372yg****

TunnelBandwidth

string

VPN アタッチメントにおける単一トンネルの帯域幅仕様を指定します。利用可能なオプションは次のとおりです。

  • Standard:標準、1 Gbps

  • Large:大容量、3 Gbps

Standard

成功レスポンス

JSONJSON

{
  "Status": "ike_sa_not_established",
  "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW****",
  "EnableNatTraversal": true,
  "CreateTime": 1492753817000,
  "EffectImmediately": true,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "LocalSubnet": "10.0.0.0/8",
  "RequestId": "F2310D45-BCF6-4E2E-9082-B4503844BA4C",
  "VpnConnectionId": "vco-bp1bbi27hojx80nck****",
  "RemoteSubnet": "192.168.0.0/16",
  "CustomerGatewayId": "cgw-bp1mvj4g9kogwwcxk****",
  "Name": "ipsec1",
  "EnableDpd": true,
  "IkeConfig": {
    "RemoteId": "139.34.XX.XX",
    "IkeLifetime": 86400,
    "IkeEncAlg": "aes",
    "LocalId": "116.28.XX.XX",
    "IkeMode": "main",
    "IkeVersion": "ikev1",
    "IkePfs": "group2",
    "Psk": "pgw6dy****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "group2"
  },
  "VcoHealthCheck": {
    "Status": "failed",
    "Dip": "10.0.0.1",
    "Interval": 3,
    "Retry": 3,
    "Sip": "192.168.1.1",
    "Enable": "true",
    "Policy": "revoke_route"
  },
  "VpnBgpConfig": {
    "Status": "success",
    "PeerBgpIp": "169.254.11.1",
    "TunnelCidr": "169.254.11.0/30",
    "EnableBgp": "true",
    "LocalBgpIp": "169.254.11.2",
    "PeerAsn": 65530,
    "LocalAsn": 65531,
    "AuthKey": "AuthKey****"
  },
  "AttachType": "CEN",
  "NetworkType": "public",
  "AttachInstanceId": "cen-lxxpbpalc776qz****",
  "Spec": "1000M",
  "State": "attached",
  "ZoneNo": "cn-hangzhou-h",
  "InternetIp": "47.XX.XX.162",
  "TransitRouterId": "tr-p0we2edef9qr44a85****",
  "TransitRouterName": "nametest",
  "CrossAccountAuthorized": false,
  "Tags": {
    "Tag": [
      {
        "Key": "TagKey",
        "Value": "TagValue"
      }
    ]
  },
  "TunnelOptionsSpecification": {
    "TunnelOptions": [
      {
        "TunnelId": "tun-opsqc4d97wni27****",
        "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
        "EnableDpd": "true",
        "EnableNatTraversal": "true",
        "InternetIp": "47.21.XX.XX",
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "Role": "master",
        "TunnelIndex": 1,
        "State": "active",
        "Status": "ipsec_sa_established",
        "TunnelBgpConfig": {
          "BgpStatus": "success",
          "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": "ikev1",
          "LocalId": "47.21.XX.XX",
          "Psk": "123456****",
          "RemoteId": "47.42.XX.XX"
        },
        "TunnelIpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecEncAlg": "aes",
          "IpsecLifetime": "86400",
          "IpsecPfs": "group2"
        },
        "ZoneNo": "cn-hangzhou-i"
      }
    ]
  },
  "EnableTunnelsBgp": true,
  "ResourceGroupId": "rg-acfmzs372yg****",
  "TunnelBandwidth": "Standard"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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.

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

変更履歴

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