すべてのプロダクト
Search

このプロダクト

    VPN Gateway:DescribeVpnGateways

    ドキュメントセンター

    VPN Gateway:DescribeVpnGateways

    最終更新日:Jul 06, 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:DescribeVpnGateways

    list

    VpnGateway

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

    VpnGateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

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

    cn-hangzhou
    VpcId

    string

    任意

    VPN ゲートウェイが属する仮想プライベートクラウド (VPC) の ID。

    vpc-bp1m3i0kn1nd4wiw9****
    VpnGatewayId

    string

    任意

    VPN ゲートウェイの ID。

    vpn-bp17lofy9fd0dnvzv****
    Status

    string

    任意

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

    • init: 初期化中。

    • provisioning: 準備中。

    • active: アクティブな。

    • updating: 更新中。

    • deleting: 削除中。

    active
    BusinessStatus

    string

    任意

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

    • Normal: 正常。

    • FinancialLocked: 支払い遅延によるロック済み。

    Normal
    PageNumber

    integer

    任意

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

    1
    PageSize

    integer

    任意

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

    10
    IncludeReservationData

    boolean

    任意

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

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

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

    true
    Tag

    array<object>

    任意

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

    object

    任意

    VPN ゲートウェイにバインドされているタグ。

    Key

    string

    任意

    タグキー。

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

    FinanceDept
    Value

    string

    任意

    タグ値。

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

    FinanceJoshua
    ResourceGroupId

    string

    任意

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

    ListResourceGroups 操作を呼び出して、リソースグループ ID をクエリできます。

    rg-acfmzs372yg****
    GatewayType

    string

    任意

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

    • Traditional: IPsec および SSL 特徴を備えた従来の VPN ゲートウェイ。

    • Enhanced.SiteToSite: IPsec 特徴のみを備えた強化されたサイト間 VPN。

    Enhanced.SiteToSite

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    PageSize

    integer

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

    10
    RequestId

    string

    リクエスト ID。

    DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    エントリの総数。

    1
    VpnGateways

    object

    VpnGateway

    array<object>

    VPN ゲートウェイのリスト。

    array<object>

    VPN ゲートウェイの情報。

    VpnType

    string

    VPN ゲートウェイのタイプ。

    有効な値: Normal (法線タイプを示します)。。

    Normal
    Status

    string

    VPN ゲートウェイのステータス。

    • init: 初期化中。

    • provisioning: プロビジョニング中。

    • active: 法線。

    • updating: 更新中。

    • deleting: 削除中。

    active
    VpcId

    string

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

    vpc-bp1m3i0kn1nd4wiw9****
    SslMaxConnections

    integer

    VPN ゲートウェイの SSL-VPN 接続の最大値。

    5
    Spec

    string

    VPN ゲートウェイのピーク帯域幅。M は単位 Mbit/s を示します。

    5M
    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 IP アドレスを割り当てます。

    47.12.XX.XX
    CreateTime

    integer

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

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

    1515383700000
    AutoPropagate

    boolean

    VPN ゲートウェイのルーティング自動伝播特徴が有効かどうかを示します。

    • true: 有効。

    • false: 無効。

    true
    ChargeType

    string

    VPN ゲートウェイの課金方法。

    値は POSTPAY で、従量課金方法を示します。

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

    string

    VPN ゲートウェイの ID。

    vpn-bp17lofy9fd0dnvzv****
    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

    VPN ゲートウェイで IPsec-VPN が有効かどうかを示します。

    • enable: 有効。

    • disable: 無効。

    enable
    EndTime

    integer

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

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

    1518105600000
    VSwitchId

    string

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

    vsw-bp15lbk8sgtr6r5b0****
    Description

    string

    VPN ゲートウェイの説明。

    test
    EnableBgp

    boolean

    VPN ゲートウェイの BGP 特徴の有効化ステータス。

    • true: 有効。

    • false: 無効。

    true
    BusinessStatus

    string

    VPN ゲートウェイの課金ステータス。

    • Normal: 法線。

    • FinancialLocked: 支払い遅延によりロック済み。

    Normal
    SslVpn

    string

    VPN ゲートウェイで SSL-VPN が有効かどうかを示します。

    • enable: 有効。

    • disable: 無効。

    enable
    Name

    string

    VPN ゲートウェイの名前。

    test
    NetworkType

    string

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

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

    • private: 非公開 VPN ゲートウェイ。

    public
    Tags

    object

    Tag

    array<object>

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

    object

    VPN ゲートウェイにバインドされたタグのフォーマット情報。

    Key

    string

    タグキー。

    FinanceDept
    Value

    string

    タグ値。

    FinanceJoshua
    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 (更新) の場合、このパラメーターは更新またはスペック変更を伴う更新が有効になる有効期間を示します。

    2021-07-20T16:00:00Z
    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。フォーマットは rg-**** です。

    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 ゲートウェイ。 Enhance.SiteToSite: IPsec の特徴のみをサポートする拡張サイト対クラウド VPN。

    Enhanced.SiteToSite

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnGateways": {
    "VpnGateway": [
      {
        "VpnType": "Normal",
        "Status": "active",
        "VpcId": "vpc-bp1m3i0kn1nd4wiw9****",
        "SslMaxConnections": 5,
        "Spec": "5M",
        "InternetIp": "47.12.XX.XX",
        "CreateTime": 1515383700000,
        "AutoPropagate": true,
        "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
        "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
        "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
        "IpsecVpn": "enable",
        "EndTime": 1518105600000,
        "VSwitchId": "vsw-bp15lbk8sgtr6r5b0****",
        "Description": "test",
        "EnableBgp": true,
        "BusinessStatus": "Normal",
        "SslVpn": "enable",
        "Name": "test",
        "NetworkType": "public",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "ReservationData": {
          "Status": "1",
          "ReservationOrderType": "TEMP_UPGRADE",
          "ReservationIpsec": "enable",
          "ReservationSpec": "5",
          "ReservationSsl": "enable",
          "ReservationMaxConnections": 5,
          "ReservationEndTime": "2021-07-20T16:00:00Z"
        },
        "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 InvalidParameter.TagKey The specified parameter TagKey is invalid. 指定された TagKey パラメーターが無効です。
    400 InvalidParameter.TagValue The specified parameter TagValue is invalid. 指定された TagValue パラメーターが無効です。
    400 Duplicated.TagKey The specified parameter TagKey is duplicated. 指定された TagKey パラメーターが重複しています。
    400 InternalError The request processing has failed due to some unknown error, exception or failure.
    403 Forbidden.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 を呼び出す権限があるかどうかを確認してください。

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

    変更履歴

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