すべてのプロダクト
Search

このプロダクト

    VPN Gateway:DescribeVpnConnections

    ドキュメントセンター

    VPN Gateway:DescribeVpnConnections

    最終更新日: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:DescribeVpnConnections

    list

    VpnConnection。

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

    VpnConnection。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

    cn-hangzhou
    VpnGatewayId

    string

    任意

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

    vpn-bp1q8bgx4xnkx****
    CustomerGatewayId

    string

    任意

    カスタマーゲートウェイの ID。

    cgw-bp1mvj4g9kogw****
    PageNumber

    integer

    任意

    リストのページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページングクエリにおける 1 ページあたりのエントリ数。デフォルト値: 10。有効な値: 1 ～ 50。

    10
    VpnConnectionId

    string

    任意

    IPsec-VPN 接続の ID。

    vco-bp10lz7aejumd****
    Tag

    array<object>

    任意

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

    object

    任意

    タグ情報。フォーマットは JSON です。

    Key

    string

    任意

    タグキー。この値は空文字列にできません。

    タグキーの長さは最大 64 文字です。aliyun または acs: で始まるもの、および http:// または https:// を含むものは指定できません。

    一度に最大 20 個のタグキーを指定できます。

    TagKey
    Value

    string

    任意

    タグ値。

    TagValue
    ResourceGroupId

    string

    任意

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

    rg-acfmzs372yg****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    PageSize

    integer

    ページングクエリにおける 1 ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    238752DC-0693-49BE-9C85-711D5691D3E5
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    返されたエントリの総数。

    2
    VpnConnections

    object

    VpnConnection

    array<object>

    IPsec-VPN 接続設定のリスト。

    array<object>

    IPsec-VPN 接続の構成。

    Status

    string

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

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

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

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

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

    ipsec_sa_established
    EnableNatTraversal

    boolean

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

    • true: NAT 越えが有効です。

      NAT 越えを有効にすると、IKE ネゴシエーションプロセスで UDP ポート番号の検証が省略され、VPN トンネル上の NAT ゲートウェイデバイスを検出できます。

    • false: NAT 越えが無効です。

    true
    RemoteCaCertificate

    string

    ピアの CA 証明書。

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

    integer

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

    タイムスタンプは UNIX フォーマットで、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過時間をミリ秒単位で表します。

    1492753817000
    EffectImmediately

    boolean

    IPsec-VPN 接続設定がすぐに効果があるかどうかを示します。

    • true: 設定変更後に再接続がトリガーされます。

    • false: トラフィックが検出されたときに再接続がトリガーされます。

    true
    VpnGatewayId

    string

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

    vpn-bp1q8bgx4xnkm****
    LocalSubnet

    string

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

    複数の CIDR ブロックはコンマ (,) で区切ります。レート制限はありません。

    192.168.0.0/16,172.17.0.0/16
    VpnConnectionId

    string

    IPsec-VPN 接続の ID。

    vco-bp10lz7aejumd****
    RemoteSubnet

    string

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

    複数の CIDR ブロックはコンマ (,) で区切ります。レート制限はありません。

    10.0.0.0/8,172.16.0.0/16
    CustomerGatewayId

    string

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

    cgw-bp1mvj4g9kogw****
    Name

    string

    IPsec-VPN 接続の名前。

    nametest
    EnableDpd

    boolean

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

    • true: DPD が有効です。

      IPsec イニシエーターは DPD パケットを送信してピアの生存を確認します。指定された時間内に正しい応答を受信しない場合、ピアは切断されたとみなされます。ISAKMP SA と対応する IPsec SA が削除され、セキュリティトンネルも削除されます。

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

    true
    IkeConfig

    object

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

    RemoteId

    string

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

    139.17.XX.XX
    IkeLifetime

    integer

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

    86400
    IkeEncAlg

    string

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

    aes
    LocalId

    string

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

    116.64.XX.XX
    IkeMode

    string

    IKE ネゴシエーションモード。レートに基づいて選択されます。

    • main: メインモード。ネゴシエーションプロセスのセキュリティレベルが高くなります。

    • aggressive: アグレッシブモード。ネゴシエーションが高速で、成功率が高くなります。

    main
    IkeVersion

    string

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

    • ikev1

    • ikev2

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

    ikev1
    IkePfs

    string

    IKE 位相の DH グループ。

    group2
    Psk

    string

    事前共有鍵。

    pgw6dy7****
    IkeAuthAlg

    string

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

    sha1
    IpsecConfig

    object

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

    IpsecAuthAlg

    string

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

    sha1
    IpsecLifetime

    integer

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

    86400
    IpsecEncAlg

    string

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

    aes
    IpsecPfs

    string

    IPsec 位相の DH グループ。

    group2
    VcoHealthCheck

    object

    IPsec-VPN 接続のヘルスチェック構成。

    Status

    string

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

    • success: 法線。

    • failed: 失敗した。

    success
    Dip

    string

    送信先 IP アドレス。

    192.168.0.1
    Interval

    integer

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

    2
    Retry

    integer

    ヘルスチェックのリトライ回数。

    3
    Sip

    string

    ソース IP アドレス。

    192.168.0.50
    Enable

    string

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

    • true: 有効。

    • false: 無効。

    true
    Policy

    string

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

    • revoke_route: ルートが取り下げられます。

    • reserve_route: ルートは取り下げられません。

    revoke_route
    VpnBgpConfig

    object

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

    Status

    string

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

    • success: 法線。

    • false: 異常。

    success
    PeerBgpIp

    string

    ピアの BGP IP アドレス。

    169.254.10.1
    TunnelCidr

    string

    IPsec-VPN 接続の BGP CIDR ブロック。CIDR ブロックは 169.254.0.0/16 のサブネットであり、サブネットマスク長は 30 です。

    169.254.10.0/30
    LocalBgpIp

    string

    Alibaba Cloud 側の BGP IP アドレス。

    169.254.10.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

    トランジットルーティングインスタンスが属する Cloud Enterprise Network (CEN) インスタンスの ID。

    cen-lxxpbpalc776qz****
    Spec

    string

    IPsec-VPN 接続の帯域幅スペック。単位: Mbps。

    1000M
    State

    string

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

    • active: IPsec-VPN 接続は VPN ゲートウェイインスタンスにバインドされており、ステータスはアクティブな状態です。

    • init: IPsec-VPN 接続はどのリソースにもバインドされておらず、初期化状態にあります。

    • attaching: IPsec-VPN 接続をトランジットルーターインスタンスにバインド中です。

    • attached: IPsec-VPN 接続はトランジットルーターインスタンスにバインドされています。

    • detaching: IPsec-VPN 接続をトランジットルーターインスタンスからバインド解除中です。

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

    • provisioning: リソースを準備中です。

    • updating: 接続を更新中です。

    • upgrading: 接続をアップグレード中です。

    • deleted: 接続は削除されています。

    attached
    TransitRouterId

    string

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

    tr-p0we2edef9qr44a85****
    TransitRouterName

    string

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

    nametest
    CrossAccountAuthorized

    boolean

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

    • true: はい。

    • false: いいえ。

    false
    InternetIp

    string

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

    説明

    このパラメーターは、IPsec-VPN 接続がトランジットルーターインスタンスにバインドされている場合にのみ返されます。

    10.XX.XX.10
    Tag

    object

    Tag

    array<object>

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

    object

    タグ情報。

    Key

    string

    タグキー。

    TagKey
    Value

    string

    タグ値。

    TagValue
    TunnelOptionsSpecification

    object

    TunnelOptions

    array<object>

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

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

    array<object>

    トンネル構成。

    TunnelId

    string

    トンネル ID。

    tun-opsqc4d97wni27****
    CustomerGatewayId

    string

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

    cgw-p0wy363lucf1uyae8****
    EnableDpd

    string

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

    • false: 無効。

    • true: 有効。

    true
    EnableNatTraversal

    string

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

    • false: 無効。

    • true: 有効。

    true
    InternetIp

    string

    トンネルの IP アドレス。

    47.21.XX.XX
    RemoteCaCertificate

    string

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

    このパラメーターは、VPN ゲートウェイインスタンスが中国暗号化アルゴリズム (SM) を使用している場合にのみ返されます。

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

    string

    トンネルのロール。

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

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

    master
    TunnelIndex

    integer

    トンネルの作成注文。

    • 1: 最初のトンネル。

    • 2: 2 番目のトンネル。

    説明

    このパラメーターは、IPsec-VPN 接続がトランジットルーターインスタンスにバインドされている場合にのみ返されます。

    1
    State

    string

    トンネルのステータス。

    • active: アクティブな。

    • updating: 更新中。

    • deleting: 削除中。

    active
    Status

    string

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

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

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

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

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

    ipsec_sa_established
    TunnelBgpConfig

    object

    トンネルの BGP 構成。

    BgpStatus

    string

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

    • success: 法線。

    • failed: 失敗した。

    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: メインモード。ネゴシエーションプロセスのセキュリティレベルが高くなります。

    • aggressive: アグレッシブモード。ネゴシエーションが高速で、成功率が高くなります。

    main
    IkePfs

    string

    IKE 位相の DH グループ。

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

    group2
    ZoneNo

    string

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

    ap-southeast-5a
    EnableTunnelsBgp

    boolean

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

    • true: 有効。

    • false: 無効。

    true
    ResourceGroupId

    string

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

    ListResourceGroups を呼び出してリソースグループ情報を取得できます。

    rg-acfmzs372yg****
    TunnelBandwidth

    string

    単一 VPN トンネルの帯域幅スペック。有効な値: Standard (デフォルト): デフォルト帯域幅 1 Gbps の標準タイプ。 Large: デフォルト帯域幅 3 Gbps の large タイプ。

    Standard

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "238752DC-0693-49BE-9C85-711D5691D3E5",
  "PageNumber": 1,
  "TotalCount": 2,
  "VpnConnections": {
    "VpnConnection": [
      {
        "Status": "ipsec_sa_established",
        "EnableNatTraversal": true,
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "CreateTime": 1492753817000,
        "EffectImmediately": true,
        "VpnGatewayId": "vpn-bp1q8bgx4xnkm****",
        "LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
        "VpnConnectionId": "vco-bp10lz7aejumd****",
        "RemoteSubnet": "10.0.0.0/8,172.16.0.0/16",
        "CustomerGatewayId": "cgw-bp1mvj4g9kogw****",
        "Name": "nametest",
        "EnableDpd": true,
        "IkeConfig": {
          "RemoteId": "139.17.XX.XX",
          "IkeLifetime": 86400,
          "IkeEncAlg": "aes",
          "LocalId": "116.64.XX.XX",
          "IkeMode": "main",
          "IkeVersion": "ikev1",
          "IkePfs": "group2",
          "Psk": "pgw6dy7****",
          "IkeAuthAlg": "sha1"
        },
        "IpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecLifetime": 86400,
          "IpsecEncAlg": "aes",
          "IpsecPfs": "group2"
        },
        "VcoHealthCheck": {
          "Status": "success",
          "Dip": "192.168.0.1",
          "Interval": 2,
          "Retry": 3,
          "Sip": "192.168.0.50",
          "Enable": "true",
          "Policy": "revoke_route"
        },
        "VpnBgpConfig": {
          "Status": "success",
          "PeerBgpIp": "169.254.10.1",
          "TunnelCidr": "169.254.10.0/30",
          "LocalBgpIp": "169.254.10.2",
          "PeerAsn": 65530,
          "LocalAsn": 65531,
          "AuthKey": "AuthKey****"
        },
        "AttachType": "CEN",
        "NetworkType": "public",
        "AttachInstanceId": "cen-lxxpbpalc776qz****",
        "Spec": "1000M",
        "State": "attached",
        "TransitRouterId": "tr-p0we2edef9qr44a85****",
        "TransitRouterName": "nametest",
        "CrossAccountAuthorized": false,
        "InternetIp": "10.XX.XX.10",
        "Tag": {
          "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": "ap-southeast-5a"
            }
          ]
        },
        "EnableTunnelsBgp": true,
        "ResourceGroupId": "rg-acfmzs372yg****",
        "TunnelBandwidth": "Standard"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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 パラメーターが重複しています。
    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 を操作する権限があるかどうかを確認してください。

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

    変更履歴

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