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

VPN Gateway:DescribeVpnConnections

最終更新日:Jun 19, 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。

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

cn-hangzhou

VpnGatewayId

string

任意

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

vpn-bp1q8bgx4xnkx****

CustomerGatewayId

string

任意

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

cgw-bp1mvj4g9kogw****

PageNumber

integer

任意

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

1

PageSize

integer

任意

ページングクエリの1ページあたりのエントリ数。デフォルト値:10。有効な値:150

10

VpnConnectionId

string

任意

IPsec-VPN 接続のID。

vco-bp10lz7aejumd****

Tag

array<object>

任意

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

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

object

任意

タグ情報。

Key

string

任意

タグキー。このパラメータを指定する場合、値を空の文字列にすることはできません。

タグキーは最大 64 文字で、aliyunまたはacs:で始めることはできません。http://またはhttps://を含めることはできません。

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

TagKey

Value

string

任意

タグ値。

タグ値は最大 128 文字で、空の文字列にすることができます。aliyunまたはacs:で始めることはできません。http://またはhttps://を含めることはできません。

各タグキーは1つのタグ値に対応します。一度に最大 20 個のタグ値を指定できます。

TagValue

ResourceGroupId

string

任意

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

ListResourceGroups 操作を呼び出して、リソースグループ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 接続のステータスです。

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

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

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

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

ipsec_sa_established

EnableNatTraversal

boolean

IPsec 接続に対して NAT 越えが有効かどうかを示します。

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

    NAT 越えを有効化すると、IKE ネゴシエーションプロシージャで UDP ポートの検証をスキップし、VPN トンネル内の NAT Gateway デバイスの検出が可能になります。

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

true

RemoteCaCertificate

string

ピアの CA 証明書です。

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

CreateTime

integer

IPsec 接続が作成された時刻を示す UNIX タイムスタンプです。単位はミリ秒です。

このタイムスタンプは UNIX 時間形式に従い、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から IPsec 接続の作成時刻までの経過時間をミリ秒単位で表します。

1492753817000

EffectImmediately

boolean

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

  • true: はい。構成変更完了後に再接続がトリガーされます。

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

true

VpnGatewayId

string

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

vpn-bp1q8bgx4xnkm****

LocalSubnet

string

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

複数の CIDR ブロックが存在する場合、カンマ (,) で区切ります。

192.168.0.0/16,172.17.0.0/16

VpnConnectionId

string

IPsec 接続の ID です。

vco-bp10lz7aejumd****

RemoteSubnet

string

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

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

10.0.0.0/8,172.16.0.0/16

CustomerGatewayId

string

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

cgw-bp1mvj4g9kogw****

Name

string

IPsec 接続の名前です。

nametest

EnableDpd

boolean

IPsec 接続に対してピア生存確認 (DPD) 機能が有効かどうかを示します。

  • true: DPD が有効です。

    リクエスト元 VPC は DPD プローブパケットを送信して、ピアデバイスが稼働しているかどうかを検出します。指定された時間内に有効な応答が受信されない場合、ピアは切断されたと見なされます。IPsec 接続は ISAKMP SA および対応する IPsec SA を削除し、セキュリティトンネルも削除されます。

  • false: DPD が無効です。リクエスト元 VPC は DPD プローブパケットを送信しません。

true

IkeConfig

object

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

RemoteId

string

IPsec 接続の Alibaba Cloud 側の ID です。

139.17.XX.XX

IkeLifetime

integer

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

86400

IkeEncAlg

string

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

aes

LocalId

string

IPsec 接続ピアのローカルデータセンター側の ID です。

116.64.XX.XX

IkeMode

string

IKE フェーズのネゴシエーションモードです。

  • main: メインモードは、ネゴシエーションプロシージャ中に高いセキュリティを提供します。

  • aggressive: アグレッシブモードは、より高速なネゴシエーションと高い成功率を実現します。

main

IkeVersion

string

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

  • ikev1

  • ikev2

IKEv1 と比較して、IKEv2 は SA ネゴシエーションプロシージャを簡素化し、複数セグメントを含むシナリオへの対応を強化しています。

ikev1

IkePfs

string

IKE フェーズ 1 で使用される Diffie-Hellman (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 フェーズで使用される Diffie-Hellman (DH) グループです。

group2

VcoHealthCheck

object

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

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 接続のボーダーゲートウェイプロトコル (BGP) ルーティング可能プロトコルの構成です。

Status

string

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

  • success: 正常です。

  • false: 異常です。

success

PeerBgpIp

string

ピア BGP IP アドレスです。

169.254.10.1

TunnelCidr

string

IPsec 接続の 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 側の自律システム番号 (ASN) です。

65531

AuthKey

string

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

AuthKey****

AttachType

string

IPsec 接続がアタッチされているリソースタイプです。

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

  • NO_ASSOCIATED: IPsec 接続がどのリソースにもアタッチされていないことを示します。

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

CEN

NetworkType

string

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

  • public: インターネット。IPsec 接続がインターネット上で暗号化された通信チャネルを確立することを示します。

  • private: プライベートネットワーク。IPsec 接続がプライベートネットワーク上で暗号化された通信チャネルを確立することを示します。

public

AttachInstanceId

string

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

cen-lxxpbpalc776qz****

Spec

string

IPsec 接続の帯域幅仕様です。単位は Mbps です。

1000M

State

string

IPsec 接続がトランジットルーターインスタンスにバインドされている状態です。

  • active: IPsec 接続が VPN ゲートウェイインスタンスにバインドされており、正常なステータスです。

  • init: IPsec 接続がどのリソースにもバインドされておらず、初期化中です。

  • attaching: IPsec 接続がトランジットルーターインスタンスにアタッチ中です。

  • attached: IPsec 接続がトランジットルーターインスタンスにアタッチされています。

  • detaching: IPsec 接続がトランジットルーターインスタンスからデタッチ中です。

  • financialLocked: 支払い遅延によりリソースが滞納ロックされています。

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

  • updating: リソースが更新中です。

  • upgrading: リソースがスペックアップ中です。

  • deleted: リソースが削除されています。

attached

TransitRouterId

string

IPsec 接続がアタッチされているトランジットルーターのインスタンス ID です。

tr-p0we2edef9qr44a85****

TransitRouterName

string

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

nametest

CrossAccountAuthorized

boolean

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

  • true: はい。

  • false: いいえ。

false

InternetIp

string

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

説明

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

10.XX.XX.10

Tag

object

Tag

array<object>

IPsec 接続にアタッチされているタグのリストです。

object

タグ情報です。

Key

string

タグキーです。

TagKey

Value

string

タグ値です。

TagValue

TunnelOptionsSpecification

object

TunnelOptions

array<object>

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

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

array<object>

トンネルの構成情報です。

TunnelId

string

トンネル ID です。

tun-opsqc4d97wni27****

CustomerGatewayId

string

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

cgw-p0wy363lucf1uyae8****

EnableDpd

string

トンネルに対してピア生存確認 (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 接続がトランジットルーターにアタッチされている場合にのみ返されます。

1

State

string

トンネルのステータスです。

  • active: ステータスは正常です。

  • updating: 更新中です。

  • deleting: 削除中です。

active

Status

string

IPsec 接続のステータスです。

  • 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 側) の自律システム番号 (ASN) です。

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 セグメントです。

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 フェーズ 1 で使用される Diffie-Hellman (DH) グループです。

group2

IkeVersion

string

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

ikev1

LocalId

string

トンネルのローカル側 (Alibaba Cloud 側) の ID です。

47.21.XX.XX

Psk

string

事前共有鍵です。

123456****

RemoteId

string

トンネルピアの ID です。

47.42.XX.XX

TunnelIpsecConfig

object

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

IpsecAuthAlg

string

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

sha1

IpsecEncAlg

string

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

aes

IpsecLifetime

string

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

86400

IpsecPfs

string

IPsec フェーズの Diffie-Hellman (DH) グループです。

group2

ZoneNo

string

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

ap-southeast-5a

EnableTunnelsBgp

boolean

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

  • true: 有効です。

  • false: 無効です。

true

ResourceGroupId

string

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

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

rg-acfmzs372yg****

TunnelBandwidth

string

単一の VPN トンネルの帯域幅仕様を指定します。有効値:
Standard (デフォルト値): 中間。デフォルト帯域幅は 1 Gbps です。
Large: large。デフォルト帯域幅は 3 Gbps です。

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.
400 InvalidParameter.TagKey The specified parameter TagKey is invalid.
400 Duplicated.TagKey The specified parameter TagKey is duplicated.
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.

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

変更履歴

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