下载VPN通道配置

最近更新时间:2018-10-26 15:00:50

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DownloadCustomerGatewayConfiguration)用于下载VPN通道配置。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DownloadCustomerGatewayConfiguration
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
VpnGatewayId String VPN网关实例ID。
VpnConnectionId String VPN通道实例ID。形如:vpnx-f49l6u0z。
CustomerGatewayVendor CustomerGatewayVendor 对端网关厂商信息对象,可通过DescribeCustomerGatewayVendors获取。
InterfaceName String 通道接入设备物理接口名称。

3. 输出参数

参数名称 类型 描述
CustomerGatewayConfiguration String XML格式配置信息。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 下载VPN通道配置

输入示例

https://vpc.tencentcloudapi.com/?Action=DownloadCustomerGatewayConfiguration
&Version=2017-03-12
&VpnGatewayId=vpngw-p4lmqawn
&VpnConnectionId=vpnx-5p7vkch8
&CustomerGatewayVendor.Platform=comware
&CustomerGatewayVendor.SoftwareVersion=V1.0
&CustomerGatewayVendor.VendorName=h3c
&InterfaceName=eth0
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码