调用ListIpsecServers获取IPsec服务端列表_专有网络 VPC-阿里云帮助中心

调用ListIpsecServers接口查看已创建的IPsec服务端。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	IPsec服务端所属地域ID。您可以通过调用DescribeRegions接口获取地域ID。	cn-hangzhou
IpsecServerName	string	否	IPsec服务端名称。名称长度为1～100个字符，不能以`http://`或`https://`开头。	test
VpnGatewayId	string	否	VPN网关的ID。	vpn-bp1q8bgx4xnkm2ogj****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	否	分页大小，取值范围：1~20，默认值：10。	10
IpsecServerId	array	否	IPsec服务端ID。
	string	否	IPsec服务端ID。N的取值范围：1~20。	iss-bp1bo3xuvcxo7ixll****

返回参数

名称	类型	描述	示例值
	object
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	请求ID。	54B48E3D-DF70-471B-AA93-08E683A1B457
TotalCount	integer	列表条目数。	10
MaxResults	integer	分页大小。	1
IpsecServers	object []	IPsec服务端信息列表。
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	long	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	long	IPsec生存时间。单位：秒。	86400
IpsecEncAlg	string	IPsec加密算法。	aes
IpsecPfs	string	Diffie-Hellman密钥交换算法。	group2

示例

正常返回示例

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"
      }
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	The specified "NextToken" (%s) is invalid.	-
403	Forbidden	User not authorized to operate on the specified resource.	您没有权限操作指定资源，请申请权限后再操作。

访问错误中心查看更多错误码。