Last updated: 2019-11-29 18:28:46

1. API Description

Domain name for API request:

This API (DownloadCustomerGatewayConfiguration) is used to download VPN tunnel configuration.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DownloadCustomerGatewayConfiguration
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
VpnGatewayId Yes String VPN gateway instance ID.
VpnConnectionId Yes String VPN tunnel instance ID, such as vpnx-f49l6u0z.
CustomerGatewayVendor Yes CustomerGatewayVendor Customer gateway vendor information object, which can be obtained through DescribeCustomerGatewayVendors.
InterfaceName Yes String Name of the physical API for tunnel access device.

3. Output Parameters

Parameter Name Type Description
CustomerGatewayConfiguration String Configuration information in XML format.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

There is no error code related to the API business logic. For other error codes, see Common Error Codes.

5. Example

Example 1 Download VPN tunnel configuration

Input example
&<Common request parameters>

Output example

  "Response": {
    "CustomerGatewayConfiguration": "# VPC utilizes unique identifiers to manipulate the configuration of\r\n# a VPN Connection. Each VPN Connection is assigned an identifier and is\r\n# associated with Virtual Private Gateway ...",
    "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.