全部產品
Search

搜尋本產品

    VPN Gateway：ListIpsecServers - 擷取IPsec服務端列表

    文件中心

    VPN Gateway：ListIpsecServers - 擷取IPsec服務端列表

    更新時間：Apr 27, 2026

    調用ListIpsecServers介面查看已建立的IPsec服務端。

    調試

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

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    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. 您沒有許可權操作指定資源，請申請許可權後再操作。

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

    變更歷史

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