全部產品
Search

搜尋本產品

    VPN Gateway：ListIpsecServers

    文件中心

    VPN Gateway：ListIpsecServers

    更新時間：Aug 07, 2026

    呼叫 ListIpsecServers 介面檢視已建立的 IPsec 伺服器端。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    否

    是否擁有下一次查詢的權杖（Token）。取值：

    • 第一次查詢和沒有下一次查詢時，均無需填寫。

    • 如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。

    caeba0bbb2be03f84eb48b699f0a****
    MaxResults

    integer

    否

    分頁大小，取值範圍：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

    是否擁有下一次查詢的權杖（Token）。取值：

    • 如果 NextToken 為空表示沒有下一次查詢。

    • 如果 NextToken 有返回值，該取值表示下一次查詢開始的權杖。

    caeba0bbb2be03f84eb48b699f0a****
    RequestId

    string

    請求 ID。

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

    integer

    清單項目數。

    10
    MaxResults

    integer

    分頁大小。

    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

    本端網段，指需要和用戶端網段互連的 VPC 側的網段。

    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

    是否已開啟雙因素驗證功能。

    • true：已開啟。

    • false：未開啟。

    true
    MaxConnections

    integer

    VPN 閘道器的 SSL 連線數規格。

    說明

    SSL-VPN 與 IPsec 伺服器端共用 SSL 連線數。例如，SSL 連線數為 5，您已經有 3 個 SSL 用戶端連線了 SSL-VPN，則您還能使用 2 個用戶端連線 IPsec 伺服器端。

    5
    ClientIpPool

    string

    用戶端網段，指提供給用戶端虛擬網路卡分配存取位址的位址區段。

    10.0.0.0/24
    IkeConfig

    object

    第一階段協商的設定。

    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

    第二階段協商的設定。

    IpsecAuthAlg

    string

    IPsec 驗證演算法。

    sha1
    IpsecLifetime

    integer

    IPsec 存留時間。單位：秒。

    86400
    IpsecEncAlg

    string

    IPsec 加密演算法。

    aes
    IpsecPfs

    string

    Diffie-Hellman 金鑰交換演算法。

    group2
    ResourceGroupId

    string

    IPsec 伺服器端所屬的資源群組 ID。

    您可以呼叫 ListResourceGroups 介面查詢資源群組資訊。

    rg-acfmzs372yg****

    樣本

    正常返回樣本

    JSON格式

    {
  "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 status code

    錯誤碼

    錯誤資訊

    描述
    400 IllegalParam.NextToken The specified NextToken is invalid. 參數 NextToken 無效。
    403 Forbidden User not authorized to operate on the specified resource. EIP 不屬於目前呼叫者，請您檢查該 EIP 是否可被您呼叫。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。