Download VPN Tunnel Configurations

Last updated: 2020-08-05 17:44:08


    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new VPC API 3.0 which is standardized and faster.

    1. API Description

    This API (GetVpnConnConfig) is used to download VPN tunnel configuration.
    Domain for API

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is GetVpnConnConfig.

    Parameter Name Required Type Description
    vpnConnId Yes String VPN tunnel ID assigned by the system, which can be vpnConnId or unVpnConnId. unVpnConnId is recommended. For example: vpnx-ol6bcqp0. Can be queried via the API DescribeVpnConn.
    vendorname Yes string Type of peer gateway device.
    platform Yes String Platform of peer gateway device.
    software Yes String Software version of peer gateway device.
    interfaceName Yes String Name of the physical interface for tunnel access device.

    3. Output Parameters

    Parameter Name Type Description
    code Int Error code, 0: Succeeded; other values: Failed
    message String Error message
    data.configFileInfo String Content in configuration file

    4. Error Codes

    The API does not have a business error code. For common error codes, see VPC Error Codes for details

    5. Example


      &<Common request parameters>


        "code" : 0,
        "message" : "ok",
        "data" : [
            "configFileInfo" : "ike keychain keychain1\r 
                     pre-shared-key address key simple key123\r  
                     quit\rike proposal 1\r 
                     encryption-algorithm aes-cbc-128\r 
                     authentication-algorithm md5\r 
                     dh group14\r sa Lifetime 60\r 
                     quit\rike profile profile1\r 
                     keychain keychain1\r 
                     local-identity fqdn remote1\r 
                     match remote identity fqdn local1\r 
                     exchange-mode aggressive\r 
                     quit\rike invalid-spi-recovery enable\ripsec transform-set transform-set1\r 
                     esp authentication-algorithm sha1\r 
                     esp encryption-algorithm aes-cbc-128\r 
                     pfs dh-group1\r 
                     quit\racl advanced 3001\r 
                     rule permit ip source destination\r
                     ipsec policy policy1 1 isakmp\r 
                     transform-set transform-set1\r 
                     security acl 3001\r 
                     ike-profile profile1\r 
                     sa Lifetime time-based 180\r 
                     sa Lifetime traffic-based 2560\r 
                     quit\rip unreachables enable\rinterface GigabitEthernet0/0\r 
                     port link-mode route\r 
                     ipsec apply policy policy1\r quit"

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback