すべてのプロダクト
Search

このプロダクト

    VPN Gateway:DescribeVpnGateway

    ドキュメントセンター

    VPN Gateway:DescribeVpnGateway

    最終更新日:Jun 19, 2026

    指定された 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 API を呼び出してリージョン ID を取得できます。

    cn-hangzhou
    VpnGatewayId

    string

    必須

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

    vpn-bp1r3v1xqkl0w519g****
    IncludeReservationData

    boolean

    任意

    保留中の注文データを含めるかどうかを指定します。有効な値:

    • false (デフォルト): 保留中の注文データを含めません。

    • true: 保留中の注文データを含めます。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    VpnType

    string

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

    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 ゲートウェイの帯域幅スペック。単位: Mbps。

    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 接続を作成するために VPN ゲートウェイインスタンスに 2 つの IPsec アドレスを割り当てます。

    47.22.XX.XX
    CreateTime

    integer

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

    タイムスタンプは UNIX フォーマットで、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から VPN ゲートウェイの作成時間までに経過したミリ秒の合計数を表します。

    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) から VPN ゲートウェイの有効期限の時間までに経過したミリ秒の合計数を表します。

    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 は、VPN ゲートウェイの一時的なアップグレード前のスペックを表します。

    1
    ReservationOrderType

    string

    保留中の注文のタイプ。有効な値:

    • RENEWCHANGE: スペックアップを伴う更新。

    • TEMP_UPGRADE: 一時的なアップグレード。

    • RENEW: 更新。

    TEMP_UPGRADE
    ReservationIpsec

    string

    保留中の注文の IPsec-VPN 特徴のステータス。有効な値:

    • enable: 有効。

    • disable: 無効。

    enable
    ReservationSpec

    string

    保留中の注文の帯域幅スペック。単位: Mbps。

    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 API を呼び出してリソースグループ情報をクエリできます。

    rg-acfmzs372yg****
    EniInstanceIds

    object

    EniInstanceId

    array

    VPN ゲートウェイインスタンス用にシステムが作成した Elastic Network Interface (ENI) のリスト。

    string

    ENI ID。

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

    eni-7xvcxgmd4y2ypibn****
    GatewayType

    string

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

    • Traditional: 従来の VPN ゲートウェイ。IPsec と SSL の両方の特徴をカバーします。

    • Enhanced.SiteToSite: 拡張サイト間 VPN。IPsec 特徴のみをカバーします。

    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.

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

    変更履歴

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