API Description

<p><strong>1. CreateVpn</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to create VPN gateway instances. Currently VPN gateway instances can be created only for the VPC with DMZ. Billing mode only supports billing by hour currently. It is charged by hour by default.</p> <p>Before creating an instance, you need to create the network domain of the available VPC and DMZ.</p> <p>When you create an instance, you need to call the <strong>SelectVpcItem</strong> to obtain VPC list information and the <strong>DescribeVpnTypes</strong> to query the VPN specification.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies the region ID of the VPN gateway instance. &nbsp;The information of region can be obtained by calling the <strong>ListRegion. </strong>For details, refer to the description of<strong> </strong>the <strong>ListRegions</strong>.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies the VPC ID, which determines where the VPN gateway instance is created. The VPC list information can be obtained by calling the <strong>SelectVpcItem. </strong>For details, refer to the description of<strong> </strong>the <strong>SelectVpcItem.</strong></p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpnTypeId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies the VPN type, which can be obtained by calling the <strong>DescribeVpnTypes. </strong>For details, refer to the description of<strong> </strong>the <strong>DescribeVpnTypes.</strong></p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Bandwidth</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies bandwidth.</p> <p>Unit: Mbps</p> <p>Value (optional): 2, 5, 10, 20, 50, and 100</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>It specifies the display name.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>Order ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>Order status</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2. CreateVpnConnection</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to create VPN connection instances.</p> <p>The gateway is connected to an IPsec VPN with the link monitor and control (LMK) enabled. The VPN gateway connection instance is built on the subnet in the availability zone.</p> <p>Before creating a VPN connection instance, you need to create a VPN gateway instance, as well as subnets in the network domain of the available VPC and DMZ.</p> <p>When you create an instance, you need to call the <strong>DescribeVpnSubnet </strong>to obtain VPN subnet list information in the availability zone.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies the VPN ID, which determines where the VPN connection instance is created.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RemoteGateway</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies the IP addresses of remote gateways.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>LocalSubnets</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies local subnet groups. If multiple subnets exist, separate them using &ldquo;,&rdquo;.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RemoteSubnets</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies remote subnet groups. If multiple subnets exist, separate them using &ldquo;,&rdquo;. E.g. 192.168.200.0/24,10.23.0.0/24(Maximum 5)。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>It specifies the display name.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeMode</p> </td> <td> <p>IkeMode</p> </td> <td> <p>yes</p> </td> <td> <p>IKE negotiation mode</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeAuthAlg</p> </td> <td> <p>VpnAuthAlg</p> </td> <td> <p>yes</p> </td> <td> <p>IKE authentication algorithm</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeEncAlg</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>IKE encryption algorithm. You can use only one of the following algorithms:</p> <p>1.&nbsp;&nbsp;&nbsp;&nbsp; 3DES encryption</p> <p>2.&nbsp;&nbsp;&nbsp;&nbsp; AES128</p> <p>3.&nbsp;&nbsp;&nbsp;&nbsp; AES256.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeDh</p> </td> <td> <p>VpnDh</p> </td> <td> <p>yes</p> </td> <td> <p>IKE DH group</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeLifeTime</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>IKE life time.</p> <p>Unit: second</p> <p>Value range: [1200, 90000]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>LocalId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Local ID.</p> <p>Suggested format: IP format or mailbox format.</p> <p>Length: a maximum of 30 characters.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RemoteId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Remote ID.</p> <p>Suggested format: IP format or mailbox format.</p> <p>Length: a maximum of 30 characters.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Psk</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>The pre shared key, which allows English letters, numbers, &ldquo;@&rdquo;, &quot;.&quot;, &quot;_&quot;, and &quot;-&quot;. Its length cannot exceeds 30 characters.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecAuthAlg</p> </td> <td> <p>VpnAuthAlg</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec authentication algorithm</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecEncAlg</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec encryption algorithm</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecDh</p> </td> <td> <p>VpnDh</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec DH group</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecLifeTime</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec life time.</p> <p>Unit: second</p> <p>Value range: [1200, 90000]</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>3. DeleteVpn</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to delete VPN gateway instances.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CheckDependency</p> </td> <td> <p>Boolean</p> </td> <td> <p>no</p> </td> <td> <p>It determines whether to check the dependency. If it is set to <strong>yes</strong>, the dependency is checked. If it is set to <strong>no</strong>, the dependency is not checked.</p> <p>It is set to <strong>yes</strong> by default.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4. DeleteVpnConnection</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to delete VPN gateway connection instances.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>5. DescribeVpnConnectionState</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to describe VPN connection state.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>State</p> </td> <td> <p>String</p> </td> <td> <p>Status</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>StateMsg</p> </td> <td> <p>String</p> </td> <td> <p>State messages</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>6. DescribeVpnConnections</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to describe VPN gateway connection instances.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>It specifies the VPN connection ID, which is used for querying a single VPN gateway connection instance.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPN connection name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Region ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpnId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPN ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>VpnConnectionStatus</p> </td> <td> <p>no</p> </td> <td> <p>VPN connection status list</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page number, which is set to <strong>1</strong> by default.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page size, which is set to <strong>1000</strong> by default.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderBy</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Sort keys, including the fields <strong>ID</strong> and <strong>Name</strong>.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderType</p> </td> <td> <p>OrderSeqType</p> </td> <td> <p>no</p> </td> <td> <p>Order type</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnConnections</p> </td> <td> <p>List&lt;VpnConnectionBean&gt;</p> </td> <td> <p>VPN connection information list</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>7. DescribeVpnLocalSubnets</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to query the local subnet list of VPN connection instances.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnConnectionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnSubnets</p> </td> <td> <p>List&lt;VpnSubnetBean&gt;</p> </td> <td> <p>VPC subnet information list</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>8. DescribeVpnRemoteSubnets</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to query the remote subnet list of VPN connection instances.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnConnectionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnSubnets</p> </td> <td> <p>List&lt;VpnSubnetBean&gt;</p> </td> <td> <p>VPC subnet information list</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>9. DescribeVpnSubnets</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to query VPN subnet group, which is for selecting the subnet when editing VPN connection.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>Response Parameter</p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>The total count.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Subnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>Subnet information list</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>10.&nbsp;DescribeVpnTypes</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to obtain VPN gateway list.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies the region ID of the VPN gateway instance. &nbsp;The information of region can be obtained by calling the <strong>ListRegion. </strong>For details, refer to the description of<strong> </strong>the <strong>ListRegions</strong>.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpnTypes</p> </td> <td> <p>List&lt;VpnIpTypeBean&gt;</p> </td> <td> <p>The information list of VPN gateway types.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>11.&nbsp;DescribeVpns</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to query the VPN.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>It specifies VPN connection ID, which is used for querying a single VPN gateway connection instance.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPN name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>LocalAddress</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Local IP address</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Region ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page number, which is set to<strong> 1</strong> by default.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page size, which is set to<strong> 1000</strong> by default.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderBy</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Sort keys, including the fields <strong>ID</strong> and <strong>Name</strong>.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderType</p> </td> <td> <p>OrderSeqType</p> </td> <td> <p>no</p> </td> <td> <p>Order type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>VpnStatus</p> </td> <td> <p>no</p> </td> <td> <p>VPN status list</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Vpns</p> </td> <td> <p>List&lt;VpnBean&gt;</p> </td> <td> <p>VPN list information</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>12.&nbsp;ModifyVpnAttribute</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to modify the attributes of VPN gateway instances, which supports only modifying the display name.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>13.&nbsp;ModifyVpnConnection</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to modify VPN gateway connection attributes.</p> <p>Note: This interface does not support updating a single attribute, so all attributes must be imported.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RemoteGateway</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>remote gateways.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>LocalSubnets</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies local subnet groups. If multiple subnets exist, separate them using &ldquo;,&rdquo;.</p> <p>Query available VPN subnet list information in available zone by interface DescribeVpnSubnets</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RemoteSubnets</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies remote subnet groups. If multiple subnets exist, separate them using &ldquo;,&rdquo;.</p> <p>E.g. 192.168.200.0/24,10.23.0.0/24(Maximum 5)。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeMode</p> </td> <td> <p>IkeMode</p> </td> <td> <p>yes</p> </td> <td> <p>IKE negotiation mode</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeAuthAlg</p> </td> <td> <p>VpnAuthAlg</p> </td> <td> <p>yes</p> </td> <td> <p>IKE authentication algorithm</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeEncAlg</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>IKE encryption algorithm. You can use only one of the following algorithms:</p> <p>1.&nbsp;&nbsp;&nbsp;&nbsp; 3DES encryption</p> <p>2.&nbsp;&nbsp;&nbsp;&nbsp; AES128</p> <p>3.&nbsp;&nbsp;&nbsp;&nbsp; AES256.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeDh</p> </td> <td> <p>VpnDh</p> </td> <td> <p>yes</p> </td> <td> <p>IKE DH group</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IkeLifeTime</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>IKE life time.</p> <p>Unit: second</p> <p>Value range: [1200, 90000]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>LocalId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Local ID.</p> <p>Suggested format: IP format or mailbox format.</p> <p>Length: a maximum of 30 characters.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RemoteId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Remote ID.</p> <p>Suggested format: IP format or mailbox format.</p> <p>Length: a maximum of 30 characters.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Psk</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Pre shared key, which allows English letters, numbers, &ldquo;@&rdquo;, &quot;.&quot;, &quot;_&quot;, and &quot;-&quot;. Its length can not exceeds 30 characters.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecAuthAlg</p> </td> <td> <p>VpnAuthAlg</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec authentication algorithm</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecEncAlg</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec encryption algorithm</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecDh</p> </td> <td> <p>VpnDh</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec DH group</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IpsecLifeTime</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>IPsec life time.</p> <p>Unit: second</p> <p>Value range: [1200, 90000]</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>14.&nbsp;ModifyVpnConnectionAttribute</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to modify VPN gateway connection attributes, which supports only modifying the display name.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>15.&nbsp;StartVpn</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to start the VPN gateway instance.</p> <p>Only stopped instance can be started again.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>16.&nbsp;StartVpnConnection</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to start the VPN gateway connection instance.</p> <p>Only stopped instance can be started again.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>17.&nbsp;StopVpn</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to stop the VPN gateway instance.</p> <p>Only running instance can be stopped.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPN ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>18.&nbsp;StopVpnConnection</strong></p> <p><strong>Interface Description</strong></p> <p>It is used to stop the VPN gateway connection instance.</p> <p>Only running instance can be stopped.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>It specifies the VPN connection ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>It specifies the job ID.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products