1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DownloadCustomerGatewayConfiguration) is used to download VPN tunnel configuration.
Default interface request rate limit: 100 times per second.
Interface update time: 2018-03-02 18:01:46.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DownloadCustomerGatewayConfiguration |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| VpnGatewayId | Yes | No | String | VPN gateway instance ID. Example: vpngw-p4lmbqwn |
| VpnConnectionId | Yes | No | String | VPN tunnel instance ID, e.g., vpnx-f49l6u0z. Example: vpnx-4p6vkch3 |
| CustomerGatewayVendor | Yes | No | CustomerGatewayVendor | Customer gateway vendor information object, which can be obtained through DescribeCustomerGatewayVendors. Example:View |
| InterfaceName | Yes | No | String | Physical API name of the channel access device. Example: eth0 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| CustomerGatewayConfiguration | String | XML format configuration information. Example: # 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 | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| InvalidParameter | Invalid input parameters. |