すべてのプロダクト
Search

このプロダクト

    VPN Gateway:DescribeVpnGateway

    ドキュメントセンター

    VPN Gateway:DescribeVpnGateway

    最終更新日:Jun 19, 2026

    DescribeVpnGatewayオペレーションを呼び出して、指定された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:DescribeVpnGateway

    get

    *VpnGateway

    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    VPNゲートウェイのリージョンID。

    DescribeRegions オペレーションを呼び出してリージョンIDを照会できます。

    cn-hangzhou
    VpnGatewayId

    string

    必須

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

    vpn-bp1r3v1xqkl0w519g****
    IncludeReservationData

    boolean

    任意

    未処理の注文データを含めるかどうかを指定します。有効な値：

    • false（デフォルト）：未処理の注文データを含めません。

    • true：未処理の注文データを含めます。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメータ。

    VpnType

    string

    VPNゲートウェイのタイプ。値：Normal、標準 VPNゲートウェイを示します。

    Normal
    Status

    string

    VPNゲートウェイのステータス。有効な値：

    • init：初期化中。

    • provisioning：準備中。

    • active：正常。

    • updating：更新中。

    • deleting：削除中。

    init
    VpcId

    string

    VPNゲートウェイが属するVPCのID。

    vpc-bp19m2yx1m5q0avyq****
    SslMaxConnections

    integer

    SSL-VPNの最大同時接続数。

    5
    Spec

    string

    VPNゲートウェイの帯域幅仕様。単位：Mbit/s。

    5
    InternetIp

    string

    • VPNゲートウェイインスタンスがシングルトンネルIPsec-VPN 接続の作成をサポートしている場合、このアドレスはVPNゲートウェイインスタンスのIPアドレスであり、IPsec-VPN 接続またはSSL-VPN 接続の作成に使用できます。

    • VPNゲートウェイインスタンスがデュアルトンネルIPsec-VPN 接続の作成をサポートしている場合、このアドレスはIPsec-VPN 接続の作成に使用される最初のIPアドレスであり、SSL-VPN 接続の作成には使用できません。

      VPNゲートウェイインスタンスがデュアルトンネルIPsec-VPN 接続の作成をサポートしている場合、システムはデュアルトンネルIPsec-VPN 接続を作成するために2つのIPsec IPアドレスをVPNゲートウェイインスタンスに割り当てます。

    47.22.XX.XX
    CreateTime

    integer

    VPNゲートウェイが作成されたタイムスタンプ。単位：ミリ秒。

    タイムスタンプはUNIX 時間形式に従い、1970 年 1 月 1 日 00:00:00 UTCからの経過ミリ秒数を表します。

    1495382400000
    AutoPropagate

    boolean

    VPNゲートウェイでルーティング自動伝播機能が有効かどうかを示します。有効な値：

    • true：有効。

    • false：無効。

    true
    ChargeType

    string

    課金方法。値：

    POSTPAY：従量課金方式。

    中国站示例值：Prepay，国际站示例值：POSTPAY
    VpnGatewayId

    string

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

    vpn-bp1r3v1xqkl0w519g****
    Tag

    string

    システムによってVPNゲートウェイに自動生成されるラベル。

    • VpnEnableBgp：VPNゲートウェイがBGP 機能をサポートしているかどうかを示します。

      • true：サポートされています。

      • false：サポートされていません。

    • VisuallySsl：VPNゲートウェイがSSLクライアントの接続情報の表示をサポートしているかどうかを示します。

      • true：サポートされています。

      • false：サポートされていません。

    • PbrPriority：VPNゲートウェイがポリシーベースルーティングのポリシー優先度の設定をサポートしているかどうかを示します。

      • true：サポートされています。

      • false：サポートされていません。

    • VpnNewImage：VPNゲートウェイが新世代 VPNゲートウェイかどうかを示します。

      • true：はい。

      • false：いいえ。

    • description：VPNゲートウェイの説明。内部システム目的でのみ使用されます。

    • VpnVersion：VPNゲートウェイのバージョン番号。

    • IDaaSNewVersion：VPNゲートウェイがEIAM 2.0インスタンスへのアタッチをサポートしているかどうかを示します。

      • true：サポートされています。

      • false：サポートされていません。

    {\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
    IpsecVpn

    string

    IPsec-VPN 機能が有効かどうかを示します。有効な値：

    • enable：有効。

    • disable：無効。

    enable
    EndTime

    integer

    VPNゲートウェイの有効期限タイムスタンプ。単位：ミリ秒。

    タイムスタンプはUNIX 時間形式に従い、1970 年 1 月 1 日 00:00:00 UTCからの経過ミリ秒数を表します。

    1544666102000
    VSwitchId

    string

    VPNゲートウェイが属するvSwitchのID。

    vsw-bp1dmzugdikc6hdgx****
    RequestId

    string

    リクエストID。

    27E4E088-8DE0-4672-BF5C-0A412389DB9E
    Description

    string

    VPNゲートウェイの説明。

    vpngatewaydescription
    EnableBgp

    boolean

    VPNゲートウェイのBGP 機能の有効化ステータス。有効な値：

    • true：有効。

    • false：無効。

    true
    BusinessStatus

    string

    VPNゲートウェイの支払いステータス。有効な値：

    • Normal：正常。

    • FinancialLocked：支払い期限超過によりロック。

    Normal
    SslVpn

    string

    SSL-VPN 機能の有効化ステータス。有効な値：

    • enable：有効。

    • disable：無効。

    enable
    Name

    string

    VPNゲートウェイの名前。

    vpngatewayname
    ReservationData

    object

    未処理の注文データ。

    説明

    このパラメータは、IncludeReservationDataがtrueに設定されている場合にのみ返されます。

    Status

    string

    未処理の注文のステータス。有効な値：

    • 1：更新または仕様変更を伴う更新の注文が有効になっていません。

    • 2：一時アップグレードの注文が有効になっています。復元時間に達すると、システムはVPNゲートウェイを一時アップグレード前の仕様に復元します。この場合、ReservationIpsec、ReservationMaxConnections、ReservationSpec、およびReservationSslは一時アップグレード前の仕様を示します。

    1
    ReservationOrderType

    string

    未処理の注文のタイプ。有効な値：

    • RENEWCHANGE：仕様変更を伴う更新。

    • TEMP_UPGRADE：一時アップグレード。

    • RENEW：更新。

    TEMP_UPGRADE
    ReservationIpsec

    string

    未処理の注文のIPsec-VPN 機能の有効化ステータス。有効な値：

    • enable：有効。

    • disable：無効。

    enable
    ReservationSpec

    string

    未処理の注文の帯域幅仕様。単位：Mbit/s。

    5
    ReservationSsl

    string

    未処理の注文のSSL-VPN 機能の有効化ステータス。有効な値：

    • enable：有効。

    • disable：無効。

    enable
    ReservationMaxConnections

    integer

    未処理の注文のSSL-VPNの最大同時接続数。

    5
    ReservationEndTime

    string

    未処理の注文タイプがTEMP_UPGRADE（一時アップグレード）の場合、このパラメータは一時アップグレードの復元時間を示します。

    未処理の注文タイプがRENEWCHANGE（仕様変更を伴う更新）またはRENEW（更新）の場合、このパラメータは更新または仕様変更を伴う更新が有効になる期間を示します。

    2020-07-20T16:00:00Z
    Tags

    object

    Tag

    array<object>

    VPNゲートウェイインスタンスにバインドされたタグのリスト。

    object

    VPNゲートウェイインスタンスにバインドされたタグのリスト。

    Key

    string

    タグキーです。

    aaa
    Value

    string

    タグ値です。

    bbb
    NetworkType

    string

    VPNゲートウェイのネットワークタイプ。

    • public：パブリックVPNゲートウェイ。

    • private：プライベートVPNゲートウェイ。

    public
    DisasterRecoveryInternetIp

    string

    IPsec-VPN 接続を作成するためにシステムによってVPNゲートウェイインスタンスに割り当てられた2 番目のIPアドレス。

    このパラメータは、デュアルトンネルIPsec-VPN 接続の作成をサポートするVPNゲートウェイインスタンスに対してのみ返されます。

    47.91.XX.XX
    DisasterRecoveryVSwitchId

    string

    VPNゲートウェイインスタンスに関連付けられた2 番目のvSwitchのID。

    このパラメータは、デュアルトンネルIPsec-VPN 接続の作成をサポートするVPNゲートウェイインスタンスに対してのみ返されます。

    vsw-p0w95ql6tmr2ludkt****
    SslVpnInternetIp

    string

    SSL-VPN 接続のIPアドレス。

    このパラメータは、デュアルトンネルIPsec-VPN 接続の作成をサポートするパブリックネットワークタイプのVPNゲートウェイインスタンスでSSL-VPN 機能が有効になっている場合にのみ返されます。

    47.74.XX.XX
    ResourceGroupId

    string

    VPNゲートウェイが属するリソースグループのID。

    ListResourceGroups オペレーションを呼び出してリソースグループ情報を照会できます。

    rg-acfmzs372yg****
    EniInstanceIds

    object

    EniInstanceId

    array

    VPNゲートウェイインスタンスのためにシステムによって作成されたElastic Network Interface（ENI）のリスト。

    string

    ENI ID。

    このパラメータは、デュアルトンネルIPsec-VPN 接続の作成をサポートするVPNゲートウェイインスタンスに対してのみ返されます。

    eni-7xvcxgmd4y2ypibn****
    GatewayType

    string

    VPNゲートウェイのタイプ。有効な値：

    • Traditional：IPsecとSSLの両方の機能をサポートする従来型 VPNゲートウェイ。

    • Enhanced.SiteToSite：IPsec 機能のみをサポートする拡張型サイト間 VPNゲートウェイ。

    Enhanced.SiteToSite

    例

    成功レスポンス

    JSONJSON

    {
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
  "IpsecVpn": "enable",
  "EndTime": 1544666102000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description": "vpngatewaydescription",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "SslVpn": "enable",
  "Name": "vpngatewayname",
  "ReservationData": {
    "Status": "1",
    "ReservationOrderType": "TEMP_UPGRADE",
    "ReservationIpsec": "enable",
    "ReservationSpec": "5",
    "ReservationSsl": "enable",
    "ReservationMaxConnections": 5,
    "ReservationEndTime": "2020-07-20T16:00:00Z"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ]
  },
  "NetworkType": "public",
  "DisasterRecoveryInternetIp": "47.91.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "47.74.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "EniInstanceIds": {
    "EniInstanceId": [
      "eni-7xvcxgmd4y2ypibn****"
    ]
  },
  "GatewayType": "Enhanced.SiteToSite"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.
    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 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.

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

    変更履歴

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