すべてのプロダクト
Search

このプロダクト

    VPN Gateway:ListIpsecServers

    ドキュメントセンター

    VPN Gateway:ListIpsecServers

    最終更新日:Aug 10, 2026

    作成済みの IPsec サーバーを照会します。

    今すぐお試しください

    この 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:ListIpsecServers

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    IPsec サーバーのリージョン ID。

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

    cn-hangzhou
    IpsecServerName

    string

    任意

    IPsec サーバーの名前。

    名前の長さは 1～100 文字である必要があります。

    test
    VpnGatewayId

    string

    任意

    VPN ゲートウェイの ID。

    vpn-bp1q8bgx4xnkm2ogj****
    NextToken

    string

    任意

    ページネーショントークン。有効な値:

    • 最初のリクエスト、または後続のクエリが存在しない場合は、このパラメーターを指定する必要はありません。

    • 後続のクエリが存在する場合は、前の API 呼び出しで返された NextToken の値を設定します。

    caeba0bbb2be03f84eb48b699f0a****
    MaxResults

    integer

    任意

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

    10
    IpsecServerId

    array

    任意

    IPsec サーバーの ID。

    iss-bp1bo3xuvcxo7ixll****

    string

    任意

    IPsec サーバーの ID。N の有効な値: 1～20。

    iss-bp1bo3xuvcxo7ixll****
    ResourceGroupId

    string

    任意

    IPsec サーバーが属するリソースグループの ID。

    IPsec サーバーは、関連付けられた VPN ゲートウェイインスタンスと同じリソースグループに属します。 DescribeVpnGateway 操作を呼び出して、VPN ゲートウェイインスタンスのリソースグループ ID をクエリできます。

    rg-acfmzs372yg****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    NextToken

    string

    ページネーショントークン。有効な値:

    • NextToken が空の場合、後続のクエリは存在しません。

    • NextToken が返される場合、その値は次のクエリのトークンを示します。

    caeba0bbb2be03f84eb48b699f0a****
    RequestId

    string

    リクエスト ID。

    54B48E3D-DF70-471B-AA93-08E683A1B457
    TotalCount

    integer

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

    10
    MaxResults

    integer

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

    1
    IpsecServers

    array<object>

    IPsec サーバーのリスト。

    array<object>

    CreationTime

    string

    IPsec サーバーが作成された時間。

    T はデリミタです。Z は協定世界時 (UTC) を示します。

    2018-12-03T10:11:55Z
    OnlineClientCount

    integer

    IPsec サーバーに接続されているクライアントの数。

    1
    InternetIp

    string

    VPN ゲートウェイのパブリック IP アドレス。

    47.22.XX.XX
    IpsecServerName

    string

    IPsec サーバーの名前。

    test
    IDaaSInstanceId

    string

    IDaaS のインスタンス ID。

    idaas-cn-hangzhou-****
    EffectImmediately

    boolean

    現在の IPsec トンネルが削除され、ネゴシエーションが再開始されるかどうかを示します。

    • true: 構成完了後にネゴシエーションが再開始されます。

    • false: トラフィックが検出されたときにネゴシエーションが再開始されます。

    false
    VpnGatewayId

    string

    VPN ゲートウェイの ID。

    vpn-bp1q8bgx4xnkm2ogj****
    LocalSubnet

    string

    ローカル CIDR ブロック。クライアント CIDR ブロックと通信する必要がある VPC 側の CIDR ブロックです。

    192.168.0.0/16,172.17.0.0/16
    Psk

    string

    事前共有鍵。

    pgw6dy7d****
    RegionId

    string

    IPsec サーバーのリージョン ID。

    cn-hangzhou
    PskEnabled

    boolean

    事前共有鍵認証が有効かどうかを示します。値は true で、事前共有鍵認証が有効であることを示します。

    true
    IpsecServerId

    string

    IPsec サーバーの ID。

    iss-bp1bo3xuvcxo7ixll****
    MultiFactorAuthEnabled

    boolean

    2 要素認証が有効かどうかを示します。

    • true: 2 要素認証が有効です。

    • false: 2 要素認証が無効です。

    true
    MaxConnections

    integer

    VPN ゲートウェイでサポートされる SSL-VPN 接続の最大値。

    説明

    SSL-VPN と IPsec サーバーは SSL-VPN 接続を共有します。たとえば、SSL-VPN 接続の最大値が 5 で、3 つの SSL クライアントが SSL-VPN に接続されている場合、IPsec サーバーに接続できるクライアントはあと 2 つだけです。

    5
    ClientIpPool

    string

    クライアント CIDR ブロック。クライアントの仮想ネットワークインターフェースに IP アドレスが割り当てられる CIDR ブロックです。

    10.0.0.0/24
    IkeConfig

    object

    位相 1 ネゴシエーションの構成。

    RemoteId

    string

    ピアの識別子。FQDN および IP アドレス形式がサポートされています。デフォルト値は空です。

    139.67.XX.XX
    IkeLifetime

    integer

    IKE ライフタイム。単位: 秒。

    86400
    IkeEncAlg

    string

    IKE 暗号化アルゴリズム。

    aes
    LocalId

    string

    IPsec サーバーの識別子。FQDN および IP アドレス形式がサポートされています。デフォルト値は、選択した VPN ゲートウェイのパブリック IP アドレスです。

    116.64.XX.XX
    IkeMode

    string

    IKE ネゴシエーションモード。有効な値:

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

    main
    IkeVersion

    string

    IKE バージョン。

    ikev2
    IkePfs

    string

    Diffie-Hellman キー交換アルゴリズム。

    group2
    IkeAuthAlg

    string

    IKE 認証アルゴリズム。

    sha1
    IpsecConfig

    object

    位相 2 ネゴシエーションの構成。

    IpsecAuthAlg

    string

    IPsec 認証アルゴリズム。

    sha1
    IpsecLifetime

    integer

    IPsec ライフタイム。単位: 秒。

    86400
    IpsecEncAlg

    string

    IPsec 暗号化アルゴリズム。

    aes
    IpsecPfs

    string

    Diffie-Hellman キー交換アルゴリズム。

    group2
    ResourceGroupId

    string

    IPsec サーバーが属するリソースグループの ID。

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

    rg-acfmzs372yg****

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "TotalCount": 10,
  "MaxResults": 1,
  "IpsecServers": [
    {
      "CreationTime": "2018-12-03T10:11:55Z",
      "OnlineClientCount": 1,
      "InternetIp": "47.22.XX.XX",
      "IpsecServerName": "test",
      "IDaaSInstanceId": "idaas-cn-hangzhou-****",
      "EffectImmediately": false,
      "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
      "LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
      "Psk": "pgw6dy7d****",
      "RegionId": "cn-hangzhou",
      "PskEnabled": true,
      "IpsecServerId": "iss-bp1bo3xuvcxo7ixll****",
      "MultiFactorAuthEnabled": true,
      "MaxConnections": 5,
      "ClientIpPool": "10.0.0.0/24",
      "IkeConfig": {
        "RemoteId": "139.67.XX.XX",
        "IkeLifetime": 86400,
        "IkeEncAlg": "aes",
        "LocalId": "116.64.XX.XX",
        "IkeMode": "main",
        "IkeVersion": "ikev2",
        "IkePfs": "group2",
        "IkeAuthAlg": "sha1"
      },
      "IpsecConfig": {
        "IpsecAuthAlg": "sha1",
        "IpsecLifetime": 86400,
        "IpsecEncAlg": "aes",
        "IpsecPfs": "group2"
      },
      "ResourceGroupId": "rg-acfmzs372yg****"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalParam.NextToken The specified NextToken is invalid. パラメーター NextToken が無効です。
    403 Forbidden User not authorized to operate on the specified resource. EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。

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

    変更履歴

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