API 描述
<p><strong>1. CreateVpn</strong></p>
<p><strong>接口描述</strong></p>
<p>创建VPN网关实例。目前仅提供按小时计费模式,默认按小时计费。<br />
目前只支持VPC下有DMZ分区的网络域能够成功创建VPN网关实例。<br />
创建实例前,您需要先在对应地域创建出可用的VPC、DMZ分区的网络域。<br />
创建实例时,您需要调用SelectVpcItem接口获取可用的Vpc列表信息;<br />
创建实例时,您需要调用DescribeVpnTypes接口获取Vpn的规格。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>RegionId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>RegionId代表一个地域,该地域决定了用户创建的Vpn网关实例分布在哪里。<br />
Region的信息可以通过调用ListRegions接口获取,具体可参考ListRegions接口。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>VpcId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPC Id,决定了用户创建的Vpn网关实例建在哪个VPC上面。<br />
可以通过SelectVpcItem接口获取,具体可参考SelectVpcItem接口。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>VpnTypeId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>产品规格。<br />
可以通过DescribeVpnTypes接口获取,具体可参考DescribeVpnTypes接口。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Bandwidth</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>带宽,单位Mbps。<br />
可选值:2、5、10、20、50、100。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>DisplayName</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>显示名称</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>ZoneId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>可用区</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>OrderId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>订单Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Status</p>
</td>
<td>
<p>OrderStatus</p>
</td>
<td>
<p>订单状态</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>ProductCode</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>产品Code</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>2. CreateVpnConnection</strong></p>
<p><strong>接口描述</strong></p>
<p>创建VPN网关连接实例。 建立的网关连接为IPSec VPN类型,且开启链路监控。<br />
VPN网关连接实例建立在可用区的子网上。<br />
创建VPN连接实例前,您需要先创建VPN网关实例。<br />
创建VPN网关实例前,您需要先在对应地域创建出可用的VPC、DMZ分区的网络域下,创建可用区的子网。<br />
创建VPN连接实例时,您需要调用DescribeVpnSubnets接口获取可用区上可用的Vpn子网列表信息。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN Id,该VPN连接实例建立在哪个VPN下。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>RemoteGateway</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>远端网关Ip地址。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>LocalSubnets</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>本端子网组。如果存在多个子网,请以英文逗号(,)进行分隔。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>RemoteSubnets</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>远端子网组。如果存在多个子网,请以英文逗号(,)进行分隔。<br />
例如192.168.200.0/24,10.23.0.0/24(最多5条)。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>DisplayName</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>显示名称</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeMode</p>
</td>
<td>
<p>IkeMode</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>IKE协商模式</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeAuthAlg</p>
</td>
<td>
<p>VpnAuthAlg</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE认证算法</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeEncAlg</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE加密算法,仅接受3des、aes128、aes256三者之一的值。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeDh</p>
</td>
<td>
<p>IkeDh</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE DH组</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeLifeTime</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE 生存时间,单位秒。<br />
取值范围:[1200, 90000]。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>LocalId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>本端Id标识。格式:IP格式或者邮箱格式。<br />
最长30个字符。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>RemoteId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>远程Id标识。格式:IP格式或者邮箱格式。<br />
最长30个字符。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Psk</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>预共享秘钥。允许英文字母, 数字, "@" 和 ".","_","-" 最长 30个字符。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecAuthAlg</p>
</td>
<td>
<p>VpnAuthAlg</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec 认证算法</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecEncAlg</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec 加密算法</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecDh</p>
</td>
<td>
<p>IpsecDh</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec DH组</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecLifeTime</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec 生存时间,单位秒。<br />
取值范围:[1200, 90000]。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeVersion</p>
</td>
<td>
<p>IkeVersion</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>ike版本</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>3. DeleteVpn</strong></p>
<p><strong>接口描述</strong></p>
<p>删除VPN网关实例。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>CheckDependency</p>
</td>
<td>
<p>Boolean</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>是否检查依赖。true,检查依赖;false,不检查依赖。<br />
默认值,true。</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>4. DeleteVpnConnection</strong></p>
<p><strong>接口描述</strong></p>
<p>删除VPN网关连接实例。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>5. DescribeVpnConnectionState</strong></p>
<p><strong>接口描述</strong></p>
<p>查询VPN连接状态</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>State</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>状态</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>StateMsg</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>状态信息</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>6. DescribeVpnConnections</strong></p>
<p><strong>接口描述</strong></p>
<p>查询VPN网关的VPN连接实例信息</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>VPN连接实例Id。<br />
仅可传入一个id值,供查询单个VPN网关连接实例时使用。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Name</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>VPN连接名称</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>RegionId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>地域Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>VpnId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>VPN Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Status</p>
</td>
<td>
<p>VpnConnectionStatus</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>VPN连接状态列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>PageNumber</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>分页页码,默认1。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>PageSize</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>分页大小,默认1000。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>OrderBy</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>排序关键字,取值范围id,name。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>OrderType</p>
</td>
<td>
<p>OrderSeqType</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>排序方式。<br />
需结合orderBy使用。</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnConnections</p>
</td>
<td>
<p>List<VpnConnectionBean></p>
</td>
<td>
<p>VPN连接信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>总数</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>7. DescribeVpnLocalSubnets</strong></p>
<p><strong>接口描述</strong></p>
<p>查询VPN连接实例的本端子网列表</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnConnectionId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnSubnets</p>
</td>
<td>
<p>List<VpnSubnetBean></p>
</td>
<td>
<p>VPC子网信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>总数</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>8. DescribeVpnRemoteSubnets</strong></p>
<p><strong>接口描述</strong></p>
<p>查询VPN连接实例的远端子网列表。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnConnectionId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnSubnets</p>
</td>
<td>
<p>List<VpnSubnetBean></p>
</td>
<td>
<p>VPC子网信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>总数</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>9. DescribeVpnSubnets</strong></p>
<p><strong>接口描述</strong></p>
<p>查询VPN子网组,供编辑Vpn连接时选择子网时使用。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>总数</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Subnets</p>
</td>
<td>
<p>List<SubnetBean></p>
</td>
<td>
<p>子网信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>10. DescribeVpnTypes</strong></p>
<p><strong>接口描述</strong></p>
<p>获取VPN网关规格列表。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>RegionId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>RegionId代表一个地域,该地域决定了用户创建的Vpn网关实例分布在哪里。<br />
Region的信息可以通过调用ListRegions接口获取,具体可参考ListRegions接口。</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>VpnTypes</p>
</td>
<td>
<p>List<VpnIpTypeBean></p>
</td>
<td>
<p>VPN网关Ip规格信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>规格总数</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>11. DescribeVpns</strong></p>
<p><strong>接口描述</strong></p>
<p>查询VPN</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>VPN实例Id。<br />
仅可传入一个id值,供查询单个VPN网关实例时使用。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Name</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>VPN名称</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>LocalAddress</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>本端Ip地址</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>RegionId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>地域Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>PageNumber</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>分页页码,默认1。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>PageSize</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>分页大小,默认1000。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>OrderBy</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>排序关键字,取值范围id,name。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>OrderType</p>
</td>
<td>
<p>OrderSeqType</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>排序方式</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Status</p>
</td>
<td>
<p>VpnStatus</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>VPN状态列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Vpns</p>
</td>
<td>
<p>List<VpnBean></p>
</td>
<td>
<p>VPN信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>总数</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>12. ModifyVpnAttribute</strong></p>
<p><strong>接口描述</strong></p>
<p>修改VPN网关实例属性,仅支持修改显示名称。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>DisplayName</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>显示名称</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>VpnTypeId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>产品规格。<br />
可以通过DescribeVpnTypes接口获取,具体可参考DescribeVpnTypes接口。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>CouponId</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>代金券Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>OrderId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p> </p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Status</p>
</td>
<td>
<p>OrderStatus</p>
</td>
<td>
<p> </p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>ProductCode</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p> </p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>13. ModifyVpnConnection</strong></p>
<p><strong>接口描述</strong></p>
<p>更新VPN网关连接信息。<br />
注意:该接口不支持更新单个属性,须传入全部的属性信息。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>LocalSubnets</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>本端子网组,以英文逗号(,)进行分隔。<br />
您可以通过DescribeVpnSubnets接口,获取可用区上可用的Vpn子网列表信息。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>RemoteSubnets</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>远端子网组,以英文逗号(,)进行分隔。<br />
例如192.168.200.0/24,10.23.0.0/24(最多5条)。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>DisplayName</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>显示名称</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeMode</p>
</td>
<td>
<p>IkeMode</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>IKE协商模式</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeAuthAlg</p>
</td>
<td>
<p>VpnAuthAlg</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE认证算法</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeEncAlg</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE加密算法,仅接受3des、aes128、aes256三者之一的值。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeDh</p>
</td>
<td>
<p>IkeDh</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE DH组</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeLifeTime</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IKE 生存时间,单位秒。<br />
取值范围:[1200, 90000]。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>LocalId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>本端Id标识。格式:IP格式或者邮箱格式。<br />
最长30个字符。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>RemoteId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>远程Id标识。格式:IP格式或者邮箱格式。<br />
最长30个字符。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Psk</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>预共享秘钥。允许英文字母, 数字, "@" 和 ".","_","-" 最长 30个字符。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecAuthAlg</p>
</td>
<td>
<p>VpnAuthAlg</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec 认证算法</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecEncAlg</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec 加密算法</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecDh</p>
</td>
<td>
<p>IpsecDh</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec DH组</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IpsecLifeTime</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>IPSec 生存时间,单位秒。<br />
取值范围:[1200, 90000]。</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IkeVersion</p>
</td>
<td>
<p>IkeVersion</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p> </p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>14. ModifyVpnConnectionAttribute</strong></p>
<p><strong>接口描述</strong></p>
<p>修改VPN网关连接实例属性,仅支持修改显示名称。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>DisplayName</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>显示名称</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
</tbody>
</table>
<p><strong>15. StartVpn</strong></p>
<p><strong>接口描述</strong></p>
<p>启动VPN网关实例。<br />
处于停止状态中的实例才能启动。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>16. StartVpnConnection</strong></p>
<p><strong>接口描述</strong></p>
<p>启动VPN网关连接实例。<br />
处于停止状态中的实例才能启动。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>17. StopVpn</strong></p>
<p><strong>接口描述</strong></p>
<p>停止VPN网关实例。<br />
处于运行状态中的实例才能停止。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>响应参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>18. StopVpnConnection</strong></p>
<p><strong>接口描述</strong></p>
<p>停止VPN网关连接实例。<br />
处于运行状态中的实例才能停止。</p>
<p><strong>请求参数</strong></p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>是否必须</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>Id</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>VPN连接Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p>响应参数</p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
<tr>
<td>
<p>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
提交成功!非常感谢您的反馈,我们会继续努力做到更好!