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 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
ResourceNotFound | 资源不存在。 |