Domain name for API request: vpc.tencentcloudapi.com.
This API is used to download VPN tunnel configurations.
A maximum of 100 requests can be initiated per second for this API.
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 Params. The value used for this API: DownloadCustomerGatewayConfiguration. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
VpnGatewayId | Yes | String | The ID of the VPN gateway instance. |
VpnConnectionId | Yes | String | The ID of the VPN tunnel instance, 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. |
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. |
This example shows you how to download VPN tunnel configuration.
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DownloadCustomerGatewayConfiguration
<Common request parameters>
{
"VpnGatewayId": "vpngw-p3lmbqwn",
"VpnConnectionId": "vpnx-3a4xoch6",
"CustomerGatewayVendor": {
"Platform": "comware",
"SoftwareVersion": "V1.0",
"VendorName": "h3c"
},
"InterfaceName": "eth0"
}
{
"Response": {
"CustomerGatewayConfiguration": "# VPC utilizes unique identifiers to manipulate the configuration of
# a VPN Connection. Each VPN Connection is assigned an identifier and is
# associated with Virtual Private Gateway ...",
"RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InvalidParameterValue.Empty | Missing parameters. |
InvalidParameterValue.Malformed | Invalid input parameter format. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?