tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DownloadCustomerGatewayConfiguration

最后更新时间：2023-08-23 14:11:08

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 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.

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. Example

Example1 Downloading VPN tunnel configuration

This example shows you how to download VPN tunnel configuration.

Input Example

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"
}

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款