すべてのプロダクト
Search

このプロダクト

    VPN Gateway:DescribeVpnConnection

    ドキュメントセンター

    VPN Gateway:DescribeVpnConnection

    最終更新日:Aug 10, 2026

    指定された IPsec-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:DescribeVpnConnection

    get

    *VpnConnection。

    acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    IPsec-VPN 接続のリージョン ID。

    DescribeRegions 操作を呼び出して、リージョン ID を照会できます。

    cn-hangzhou
    VpnConnectionId

    string

    必須

    IPsec-VPN 接続の ID。

    vco-bp1bbi27hojx80nck****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    Status

    string

    IPsec-VPN 接続のステータス。

    • ike_sa_not_established: 位相 1 のネゴシエーションに失敗しました。

    • ike_sa_established: 位相 1 のネゴシエーションに成功しました。

    • ipsec_sa_not_established: 位相 2 のネゴシエーションに失敗しました。

    • ipsec_sa_established: 位相 2 のネゴシエーションに成功しました。

    ike_sa_not_established
    RemoteCaCertificate

    string

    ピアの CA 証明書。

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

    boolean

    IPsec-VPN 接続で NAT 越えが有効かどうかを示します。

    true
    CreateTime

    integer

    IPsec-VPN 接続が作成されたタイムスタンプ。単位: ミリ秒。

    このタイムスタンプは UNIX タイムスタンプ形式で、1970 年 1 月 1 日 00:00:00 (UTC) から IPsec-VPN 接続が作成された時刻までに経過したミリ秒の総数を表します。

    1492753817000
    EffectImmediately

    boolean

    IPsec-VPN 接続の構成がすぐに有効になるかどうかを示します。

    • true: 構成はすぐに有効になります。構成の変更が完了すると、再接続がトリガーされます。

    • false: 構成はすぐには有効になりません。トラフィックが検出されると、再接続がトリガーされます。

    true
    VpnGatewayId

    string

    VPN ゲートウェイのインスタンス ID。

    vpn-bp1q8bgx4xnkm2ogj****
    LocalSubnet

    string

    IPsec-VPN 接続の Alibaba Cloud 側の CIDR ブロック。

    10.0.0.0/8
    RequestId

    string

    リクエスト ID。

    F2310D45-BCF6-4E2E-9082-B4503844BA4C
    VpnConnectionId

    string

    IPsec-VPN 接続の ID。

    vco-bp1bbi27hojx80nck****
    RemoteSubnet

    string

    オンプレミスデータセンター側の CIDR ブロック。

    192.168.0.0/16
    CustomerGatewayId

    string

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

    cgw-bp1mvj4g9kogwwcxk****
    Name

    string

    IPsec-VPN 接続の名前。

    ipsec1
    EnableDpd

    boolean

    IPsec-VPN 接続で Dead Peer Detection (DPD) が有効かどうかを示します。

    true
    IkeConfig

    object

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

    RemoteId

    string

    IPsec-VPN 接続のオンプレミスデータセンター側の識別子。

    139.34.XX.XX
    IkeLifetime

    integer

    IKE 位相の有効時間。単位: 秒。

    86400
    IkeEncAlg

    string

    IKE 位相の暗号化アルゴリズム。

    aes
    LocalId

    string

    IPsec-VPN 接続の Alibaba Cloud 側の識別子。

    116.28.XX.XX
    IkeMode

    string

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

    main
    IkeVersion

    string

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

    • ikev1

    • ikev2

    IKEv2 は IKEv1 と比較して、SA ネゴシエーションプロセスを簡素化し、マルチ CIDR ブロックシナリオに対するサポートが強化されています。

    ikev1
    IkePfs

    string

    IKE 位相の DH グループ。

    グループ2
    Psk

    string

    事前共有鍵。

    pgw6dy****
    IkeAuthAlg

    string

    IKE 位相の認証アルゴリズム。

    sha1
    IpsecConfig

    object

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

    IpsecAuthAlg

    string

    IPsec 位相の認証アルゴリズム。

    sha1
    IpsecLifetime

    integer

    IPsec 位相の有効時間。単位: 秒。

    86400
    IpsecEncAlg

    string

    IPsec 位相の暗号化アルゴリズム。

    aes
    IpsecPfs

    string

    IPsec 位相の DH グループ。

    グループ2
    VcoHealthCheck

    object

    IPsec-VPN 接続のヘルスチェック情報。

    Status

    string

    ヘルスチェックのステータス。

    失敗した
    Dip

    string

    送信先 IP アドレス。

    10.0.0.1
    Interval

    integer

    ヘルスチェックの再試行間隔。単位: 秒。

    3
    Retry

    integer

    ヘルスチェックの再試行回数。

    3
    Sip

    string

    ソース IP アドレス。

    192.168.1.1
    Enable

    string

    IPsec-VPN 接続のヘルスチェックが有効かどうかを示します。

    • false: 無効です。

    • true: 有効です。

    true
    Policy

    string

    ヘルスチェック失敗時に公開ルートが取り下げられるかどうかを示します。

    revoke_route
    VpnBgpConfig

    object

    IPsec-VPN 接続の BGP ルーティングプロトコル構成。

    Status

    string

    BGP ルーティングプロトコルのネゴシエーションステータス。

    success
    PeerBgpIp

    string

    ピアの BGP IP アドレス。

    169.254.11.1
    TunnelCidr

    string

    IPsec-VPN 接続の BGP CIDR ブロック。この CIDR ブロックは、169.254.0.0/16 内のプレフィックス長が 30 ビットのサブネットです。

    169.254.11.0/30
    EnableBgp

    string

    BGP ルーティングプロトコルの有効化ステータス。

    true
    LocalBgpIp

    string

    Alibaba Cloud 側の BGP IP アドレス。

    169.254.11.2
    PeerAsn

    integer

    ピアの自律システム番号。

    65530
    LocalAsn

    integer

    Alibaba Cloud 側の自律システム番号。

    65531
    AuthKey

    string

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

    AuthKey****
    AttachType

    string

    IPsec-VPN 接続にアタッチされているリソースのタイプ。

    • CEN: IPsec-VPN 接続が Cloud Enterprise Network (CEN) インスタンスのトランジットルーターにアタッチされています。

    • NO_ASSOCIATED: IPsec-VPN 接続がどのリソースにもアタッチされていません。

    • VPNGW: IPsec-VPN 接続が VPN ゲートウェイインスタンスにアタッチされています。

    CEN
    NetworkType

    string

    IPsec-VPN 接続のネットワークタイプ。

    • public: パブリックネットワーク。IPsec-VPN 接続はインターネット上に暗号化された通信チャネルを確立します。

    • private: プライベートネットワーク。IPsec-VPN 接続はプライベートネットワーク上に暗号化された通信チャネルを確立します。

    public
    AttachInstanceId

    string

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

    cen-lxxpbpalc776qz****
    Spec

    string

    IPsec-VPN 接続の帯域幅仕様。単位: Mbps。

    1000M
    State

    string

    IPsec-VPN 接続とトランジットルーターインスタンス間のバインドステータス。

    attached
    ZoneNo

    string

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

    DescribeZones 操作を呼び出して、ゾーン ID とゾーンの対応関係を照会できます。

    cn-hangzhou-h
    InternetIp

    string

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

    47.XX.XX.162
    TransitRouterId

    string

    IPsec-VPN 接続にアタッチされているトランジットルーターインスタンスのインスタンス ID。

    tr-p0we2edef9qr44a85****
    TransitRouterName

    string

    トランジットルーターインスタンスの名前。

    nametest
    CrossAccountAuthorized

    boolean

    IPsec-VPN 接続が別のアカウントのトランジットルーターインスタンスにバインドされているかどうかを示します。

    false
    Tags

    object

    Tag

    array<object>

    IPsec-VPN 接続にバインドされているタグのリスト。

    object

    タグ情報。

    Key

    string

    タグキー。

    TagKey
    Value

    string

    タグ値。

    TagValue
    TunnelOptionsSpecification

    object

    TunnelOptions

    array<object>

    IPsec-VPN 接続のトンネル構成。

    array<object>

    トンネル構成。

    TunnelId

    string

    トンネル ID。

    tun-opsqc4d97wni27****
    CustomerGatewayId

    string

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

    cgw-p0wy363lucf1uyae8****
    EnableDpd

    string

    トンネルで Dead Peer Detection (DPD) が有効かどうかを示します。

    true
    EnableNatTraversal

    string

    トンネルで NAT 越えが有効かどうかを示します。

    true
    InternetIp

    string

    トンネルの IP アドレス。

    47.21.XX.XX
    RemoteCaCertificate

    string

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

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

    string

    トンネルのロール。

    master
    TunnelIndex

    integer

    トンネルの作成順序。

    1
    State

    string

    トンネルのステータス。

    active
    Status

    string

    IPsec-VPN 接続のステータス。

    ipsec_sa_established
    TunnelBgpConfig

    object

    トンネルの BGP 構成。

    BgpStatus

    string

    BGP ネゴシエーションステータス。

    success
    LocalAsn

    string

    トンネルのローカルエンド (Alibaba Cloud 側) の自律システム番号。

    65530
    LocalBgpIp

    string

    トンネルのローカルエンド (Alibaba Cloud 側) の BGP IP アドレス。

    169.254.10.1
    PeerAsn

    string

    トンネルピアの自律システム番号。

    65531
    PeerBgpIp

    string

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

    169.254.10.2
    TunnelCidr

    string

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

    169.254.10.0/30
    TunnelIkeConfig

    object

    位相 1 ネゴシエーションの構成。

    IkeAuthAlg

    string

    IKE 位相の認証アルゴリズム。

    sha1
    IkeEncAlg

    string

    IKE 位相の暗号化アルゴリズム。

    aes
    IkeLifetime

    string

    IKE 位相の有効時間。単位: 秒。

    86400
    IkeMode

    string

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

    main
    IkePfs

    string

    IKE 位相の DH グループ。

    グループ2
    IkeVersion

    string

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

    ikev1
    LocalId

    string

    トンネルのローカル側 (Alibaba Cloud 側) の識別子。

    47.21.XX.XX
    Psk

    string

    事前共有鍵。

    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 グループ。

    グループ2
    ZoneNo

    string

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

    DescribeZones 操作を呼び出して、ゾーン ID とゾーンの対応関係を照会できます。

    cn-hangzhou-i
    EnableTunnelsBgp

    boolean

    トンネル BGP の有効化ステータス。

    true
    ResourceGroupId

    string

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

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

    rg-acfmzs372yg****
    TunnelBandwidth

    string

    単一 VPN トンネルの帯域幅仕様。有効な値:

    標準

    例

    成功レスポンス

    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": "グループ2",
    "Psk": "pgw6dy****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "グループ2"
  },
  "VcoHealthCheck": {
    "Status": "失敗した",
    "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": "グループ2",
          "IkeVersion": "ikev1",
          "LocalId": "47.21.XX.XX",
          "Psk": "123456****",
          "RemoteId": "47.42.XX.XX"
        },
        "TunnelIpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecEncAlg": "aes",
          "IpsecLifetime": "86400",
          "IpsecPfs": "グループ2"
        },
        "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. EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。
    404 InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist. 指定された VPN 接続が存在しません。VPN 接続 ID が正しいかどうかを確認してください。

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

    変更履歴

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