有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
CustomerGatewayConfiguration String XML格式配置信息。
示例值:# 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 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 下载VPN通道配置

下载VPN通道配置

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DownloadCustomerGatewayConfiguration
<公共请求参数>

{
    "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\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。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.Empty 缺少参数。
InvalidParameterValue.Malformed 入参格式不合法。
ResourceNotFound 资源不存在。