调用ListIpsecServers接口查看已创建的IPsec服务端。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListIpsecServers |
系统规定参数。取值:ListIpsecServers。 |
RegionId | String | 是 | cn-hangzhou |
IPsec服务端所属地域ID。 |
IpsecServerName | String | 否 | test |
IPsec服务端名称。 |
VpnGatewayId | String | 否 | vpn-bp1q8bgx4xnkm2ogj**** |
VPN网关的ID。 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** |
是否拥有下一次查询的令牌(Token)。取值:
|
MaxResults | Integer | 否 | 10 |
分页大小,取值范围:1~20,默认值:10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NextToken | String | caeba0bbb2be03f84eb48b699f0a**** |
是否拥有下一次查询的令牌(Token)。取值:
|
RequestId | String | 54B48E3D-DF70-471B-AA93-08E683A1B457 |
请求ID。 |
TotalCount | Integer | 10 |
列表条目数。 |
MaxResults | Integer | 1 |
分页大小。 |
IpsecServers | Array of IpsecServer |
IPsec服务端信息列表。 |
|
CreationTime | String | 2018-12-03T10:11:55Z |
IPsec服务端创建时间。 T表示分隔符,Z表示的是UTC,即世界标准时间。 |
OnlineClientCount | Integer | 1 |
已经连接IPsec服务端的客户端数量。 |
InternetIp | String | 47.22.XX.XX |
VPN网关公网IP地址。 |
IpsecServerName | String | test |
IPsec服务端名称。 |
IDaaSInstanceId | String | idaas-cn-hangzhou-**** |
IDaaS实例ID。 |
EffectImmediately | Boolean | false |
是否删除当前已协商成功的IPsec隧道并重新发起协商。
|
VpnGatewayId | String | vpn-bp1q8bgx4xnkm2ogj**** |
VPN网关的ID。 |
LocalSubnet | String | 192.168.0.0/16,172.17.0.0/16 |
本端网段,指需要和客户端网段互连的VPC侧的网段。 |
Psk | String | pgw6dy7d**** |
预共享密钥。 |
RegionId | String | cn-hangzhou |
IPsec服务端所属地域ID。 |
PskEnabled | Boolean | true |
是否开启预共享密钥认证方式。仅取值为true,表示开启预共享密钥认证方式。 |
IpsecServerId | String | iss-bp1bo3xuvcxo7ixll**** |
IPsec服务端ID。 |
MultiFactorAuthEnabled | Boolean | true |
是否已开启双因子认证功能。
|
MaxConnections | Integer | 5 |
VPN网关的SSL连接数规格。 说明 SSL-VPN与IPsec服务端共享SSL连接数。例如,SSL连接数为5,您已经有3个SSL客户端连接了SSL-VPN,则您还能使用2个客户端连接IPsec服务端。
|
ClientIpPool | String | 10.0.0.0/24 |
客户端网段,指给客户端虚拟网卡分配访问地址的地址段。 |
IkeConfig | Object |
第一阶段协商的配置。 |
|
RemoteId | String | 139.67.XX.XX |
对端标识符。支持FQDN和IP地址格式,默认为空。 |
IkeLifetime | Long | 86400 |
IKE生存时间。单位:秒。 |
IkeEncAlg | String | aes |
IKE加密算法。 |
LocalId | String | 116.64.XX.XX |
IPsec服务端标识符。支持FQDN和IP地址格式,默认为当前选取的VPN网关公网IP地址。 |
IkeMode | String | main |
IKE版本协商模式。 |
IkeVersion | String | ikev2 |
IKE版本。 |
IkePfs | String | group2 |
Diffie-Hellman密钥交换算法。 |
IkeAuthAlg | String | sha1 |
IKE认证算法。 |
IpsecConfig | Object |
第二阶段协商的配置。 |
|
IpsecAuthAlg | String | sha1 |
IPsec认证算法。 |
IpsecLifetime | Long | 86400 |
IPsec生存时间。单位:秒。 |
IpsecEncAlg | String | aes |
IPsec加密算法。 |
IpsecPfs | String | group2 |
Diffie-Hellman密钥交换算法。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListIpsecServers
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListIpsecServersResponse>
<NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>
<RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
<TotalCount>10</TotalCount>
<MaxResults>1</MaxResults>
<IpsecServers>
<CreationTime>2018-12-03T10:11:55Z</CreationTime>
<OnlineClientCount>1</OnlineClientCount>
<InternetIp>47.22.XX.XX</InternetIp>
<IpsecServerName>test</IpsecServerName>
<IDaaSInstanceId>idaas-cn-hangzhou-****</IDaaSInstanceId>
<EffectImmediately>false</EffectImmediately>
<VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
<LocalSubnet>192.168.0.0/16,172.17.0.0/16</LocalSubnet>
<Psk>pgw6dy7d****</Psk>
<RegionId>cn-hangzhou</RegionId>
<PskEnabled>true</PskEnabled>
<IpsecServerId>iss-bp1bo3xuvcxo7ixll****</IpsecServerId>
<MultiFactorAuthEnabled>true</MultiFactorAuthEnabled>
<MaxConnections>5</MaxConnections>
<ClientIpPool>10.0.0.0/24</ClientIpPool>
<IkeConfig>
<RemoteId>139.67.XX.XX</RemoteId>
<IkeLifetime>86400</IkeLifetime>
<IkeEncAlg>aes</IkeEncAlg>
<LocalId>116.64.XX.XX</LocalId>
<IkeMode>main</IkeMode>
<IkeVersion>ikev2</IkeVersion>
<IkePfs>group2</IkePfs>
<IkeAuthAlg>sha1</IkeAuthAlg>
</IkeConfig>
<IpsecConfig>
<IpsecAuthAlg>sha1</IpsecAuthAlg>
<IpsecLifetime>86400</IpsecLifetime>
<IpsecEncAlg>aes</IpsecEncAlg>
<IpsecPfs>group2</IpsecPfs>
</IpsecConfig>
</IpsecServers>
</ListIpsecServersResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
}
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源,请申请权限后再操作。 |
访问错误中心查看更多错误码。